List members in segment

GET

https://api.mailchimp.com/3.0/lists/:list_id/segments/:segment_id/members

GET

/3.0/lists/:list_id/segments/:segment_id/members

curl -G https://api.mailchimp.com/3.0/lists/list_id/segments/segment_id/members \
     -H "Authorization: Bearer <token>" \
     -d include_cleaned=false \
     -d include_transactional=false \
     -d include_unsubscribed=false

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "members": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "email_address": "string",
      "email_client": "string",
      "email_type": "string",
      "full_name": "string",
      "id": "string",
      "interests": {},
      "ip_opt": "string",
      "ip_signup": "string",
      "language": "string",
      "last_changed": "2024-01-15T09:30:00Z",
      "last_note": {
        "created_at": "2024-01-15T09:30:00Z",
        "created_by": "string",
        "note": "string",
        "note_id": 1
      },
      "list_id": "string",
      "location": {
        "country_code": "string",
        "dstoff": 1,
        "gmtoff": 1,
        "latitude": 1.1,
        "longitude": 1.1,
        "timezone": "string"
      },
      "member_rating": 1,
      "merge_fields": {},
      "stats": {
        "avg_click_rate": 1.1,
        "avg_open_rate": 1.1
      },
      "status": "subscribed",
      "timestamp_opt": "2024-01-15T09:30:00Z",
      "timestamp_signup": "2024-01-15T09:30:00Z",
      "unique_email_id": "string",
      "vip": true
    }
  ],
  "total_items": 1
}

Get information about members in a saved segment.

Authentication

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

Path parameters

list_idstringRequired

The unique ID for the list.

segment_idstringRequired

The unique id for the segment.

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

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

include_cleanedbooleanOptional

Include cleaned members in response

include_transactionalbooleanOptional

Include transactional members in response

include_unsubscribedbooleanOptional

Include unsubscribed members in response

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

memberslist of objectsOptional

An array of objects, each representing a specific list member.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.