Get a list

Get a list

get

Get the specified list given its ID.

Authorizations
Path parameters
workspaceIdstring · uuidRequired

Your workspace identifier.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61
listIdstring · uuidRequired

The ID of a list.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61
Responses
200
The list was returned successfully.
application/json
get
GET /workspaces/{workspaceId}/lists/{listId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "US Customers",
  "description": "A list of all US customers",
  "createdAt": "2025-07-03T20:51:26.598Z",
  "updatedAt": "2025-07-03T20:51:26.598Z",
  "contactCount": 100,
  "consentType": "single",
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "isProof": true,
  "counter": {
    "count": 1,
    "updatedAt": "2025-07-03T20:51:26.598Z"
  }
}

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 ID: 123e4567-e89b-12d3-a456-426614174000

Get a list

In this example, we are fetching the list given its ID.

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

Last updated

Was this helpful?