MAmailchimp
audiences

A collection of Audience Contacts

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

get/3.0/audiences/{audience_id}/contacts

Request

Path parameters

audience_idstring required

The unique ID for the audience.

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

cursorstring

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_beforestring date-time

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_sincestring date-time

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

updated_beforestring date-time

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_sincestring date-time

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

sort_field'created_at' | 'updated_at'

Specifies the field to sort the returned contacts by.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

Response

next_cursorstring

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.

Example response

{
  "contacts": [
    {
      "audience_id": "773280e405",
      "email_channel": {
        "email": "example@freddiemail.com",
        "hashed_email": "9115d71ba28088047d342e3bcedacd0f",
        "marketing_consent": {
          "captured_at": "2024-01-15T10:30:00Z"
        }
      },
      "id": "7CCF816ADF6CE1B11AE09BB024A02B9B",
      "language": "en",
      "sms_channel": {
        "marketing_consent": {
          "captured_at": "2024-01-15T10:30:00Z"
        },
        "sms_phone": "+14045550102",
        "hashed_sms_phone": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609"
      },
      "status": "active"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.