Get a list

Get a list

Get the specified list given its ID.

get

/workspaces/{workspaceId}/lists/{listId}

Authorizations

MessageBird_userMessageBird_accessKey

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bird.com/workspaces/{workspaceId}/lists/{listId}' \
  --header 'Authorization: Bearer JWT'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "US Customers",
  "description": "A list of all US customers",
  "createdAt": "2025-02-21T18:03:09.887Z",
  "updatedAt": "2025-02-21T18:03:09.887Z",
  "contactCount": 100,
  "isProof": true,
  "counter": {
    "count": 1,
    "updatedAt": "2025-02-21T18:03:09.887Z"
  },
  "consentType": "single",
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

The list was returned successfully.

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.

Request

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"

Response (200 OK)

{
  "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"
}