Last updated 5 months ago
Was this helpful?
Let's establish some of our data that will be used in the following examples:
Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352
AccessKey: abcd
In this example, we are listing lists from a given workspace.
curl -X GET "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists" \ -H "Content-Type: application/json" \ -H "Authorization: AccessKey abcd"
{ "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" }Ï ] }
This endpoint will return a list of contact lists from your workspace.
Your workspace identifier.
b4e02c85-c6d2-4b15-8885-e09671799c61
GET /workspaces/{workspaceId}/lists HTTP/1.1 Host: api.bird.com Authorization: Bearer JWT Accept: */*
A list of contact lists was returned. The list can be empty if no lists are found.
{ "results": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "US Customers", "description": "A list of all US customers", "createdAt": "2025-05-09T04:43:06.152Z", "updatedAt": "2025-05-09T04:43:06.152Z", "contactCount": 100, "consentType": "single", "tags": [ "123e4567-e89b-12d3-a456-426614174000" ], "isProof": true, "counter": { "count": 1, "updatedAt": "2025-05-09T04:43:06.152Z" } } ] }