Skip to navigation

Get Snapshot Member Contact IDs

Get the contact IDs of the members in a segment snapshot, one page at a time.

Authentication

AuthorizationBearer

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

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

segment_idstringRequired
The unique id for the segment.
snapshot_idstringRequired
The unique id for the snapshot.

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
limitintegerOptional<=500000Defaults to 100000
The number of members to return in one page. The default is 100000. The maximum is 500000.
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.

Response

The API returns this when the snapshot is complete.
memberslist of objectsOptional
A list of the members in a segment snapshot.
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.