List lists

List lists

This endpoint will return a list of contact lists from your workspace.

GEThttps://api.bird.com/workspaces/{workspaceId}/lists

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

Response

200404

A list of contact lists was returned. The list can be empty if no lists are found.

Body

application/json

resultsarray of Contacts_Group (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/lists', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "US Customers",
      "description": "A list of all US customers",
      "createdAt": "2024-12-21T16:24:01.522Z",
      "updatedAt": "2024-12-21T16:24:01.522Z",
      "contactCount": 100,
      "consentType": "single",
      "tags": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "isProof": false
    }
  ]
}

Examples

Let's establish some of our data that will be used in the following examples:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• AccessKey: abcd

List your lists

In this example, we are listing lists from a given workspace.

Request

curl -X GET "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

Response (200 OK)

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "US Customers",
      "description": "US Customers",
      "contactCount": 0,
      "tags": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "isProof": false,
      "consentType": "single",
      "createdAt": "2024-11-26T15:00:00.000Z",
      "updatedAt": "2024-11-26T15:00:00.000Z"
    }Ï
  ]
}