Skip to navigation

A collection of Audience Contacts

Get a list of omni-channel contacts for a given audience.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

audience_idstringRequired
The unique ID for the audience.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countintegerOptional<=1000Defaults to 10
The number of records to return. Default value is 10. Maximum value is 1000
cursorstringOptional

Paginate through a collection of records by setting the cursor parameter to a next_cursor attribute returned by a previous request. Default value fetches the first "page" of results.

created_beforedatetimeOptional

Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.

created_sincedatetimeOptional

Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.

updated_beforedatetimeOptional

Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.

updated_sincedatetimeOptional

Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.

sort_fieldenumOptional
Specifies the field to sort the returned contacts by.
Allowed values:
sort_direnumOptional
Determines the order direction for sorted results.
Allowed values:

Response

This endpoint returns an object.
contactslist of objectsOptional
An array of objects, each representing a contact record.
next_cursorstringOptionalRead-only

A cursor pointing to the last item on this page of the collection. Paginate through a collection of records by setting the cursor parameter on a subsequent request to this value.