Get contacts in a list

GET

https://api.brevo.com/v3/contacts/lists/:listId/contacts

GET

/v3/contacts/lists/:listId/contacts

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.contacts.getContactsFromList({
        listId: 1,
    });
}
main();

{
  "contacts": [
    {
      "attributes": {
        "DOB": "2010-12-31",
        "FIRSTNAME": "Alex",
        "GENDER": "Kid",
        "LASTNAME": "Pain"
      },
      "createdAt": "2017-05-12T12:30:00Z",
      "emailBlacklisted": false,
      "id": 45,
      "listIds": [
        12,
        9,
        20
      ],
      "modifiedAt": "2017-05-12T12:30:00Z",
      "smsBlacklisted": true,
      "whatsappBlacklisted": false,
      "email": "alex.pain@example.com",
      "listUnsubscribed": [
        1,
        2
      ]
    },
    {
      "attributes": {
        "DOB": "1986-06-21",
        "FIRSTNAME": "John",
        "GENDER": "Men",
        "LASTNAME": "Smith"
      },
      "createdAt": "2017-05-12T12:30:00Z",
      "emailBlacklisted": true,
      "id": 32,
      "listIds": [
        12
      ],
      "modifiedAt": "2017-05-12T12:30:00Z",
      "smsBlacklisted": false,
      "whatsappBlacklisted": false,
      "email": "john.smith@example.com",
      "listUnsubscribed": [
        1
      ]
    },
    {
      "attributes": {
        "DOB": "1988-11-02",
        "FIRSTNAME": "Helen",
        "GENDER": "Women",
        "LASTNAME": "Rose",
        "SMS": "3375599887766"
      },
      "createdAt": "2017-05-12T12:30:00Z",
      "emailBlacklisted": true,
      "id": 65,
      "listIds": [
        12,
        9,
        20
      ],
      "modifiedAt": "2017-05-12T12:30:00Z",
      "smsBlacklisted": false,
      "whatsappBlacklisted": false,
      "email": "helen.rose@example.com",
      "listUnsubscribed": [
        1
      ]
    }
  ],
  "count": 17655
}

Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Path parameters

listIdlongRequired

Id of the list

Query parameters

modifiedSincestringOptional

Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

limitlongOptional1-500Defaults to 50

Number of documents per page

offsetlongOptionalDefaults to 0

Index of the first document of the page

sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

Contact informations

contactslist of objects

countlong

Number of contacts

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error