Get contact list memberships

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
Contact ID: 12bd0e40-9361-4e32-8b26-99b4ab7eae09

Get the lists a contact is assigned to

In this example, we're listing all the lists a contact is assigned to given a contact ID.

Last updated 6 days ago

Get contact list memberships

This endpoint will return a list of lists a contact is a member of.

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

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

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

contactId*string

The ID of a contact.

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

Response

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

Body

resultsarray of Contacts_Group (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

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

Response

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "US Customers",
      "description": "A list of all US customers",
      "createdAt": "2024-12-03T15:20:35.237Z",
      "updatedAt": "2024-12-03T15:20:35.237Z",
      "contactCount": 100,
      "consentType": "single",
      "tags": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "isProof": false
    }
  ],
  "nextPageToken": "text"
}