MAmailchimp
segments
snapshots

Get Snapshot Member Contact IDs

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

get/3.0/segments/{segment_id}/snapshots/{snapshot_id}/members

Request

Path parameters

segment_idstring required

The unique id for the segment.

snapshot_idstring required

The unique id for the snapshot.

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

limitinteger

The number of members to return in one page. The default is 1000. The maximum is 100000.

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.

Response

The API returns this when the snapshot is complete.

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.

total_itemsinteger

The total number of members in the snapshot. It is the same on each page.

Example response

{
  "members": [
    {
      "contact_id": "abc123def456"
    }
  ],
  "total_items": 4213
}

Changes

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