List segments

GET

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

GET

/3.0/lists/:list_id/segments

curl -G https://api.mailchimp.com/3.0/lists/list_id/segments \
     -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"
    }
  ],
  "list_id": "string",
  "segments": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "id": 1,
      "list_id": "string",
      "member_count": 1,
      "name": "string",
      "options": {
        "conditions": [
          {
            "condition_type": "Aim",
            "field": "aim",
            "op": "open",
            "value": "any"
          }
        ],
        "match": "any"
      },
      "type": "saved",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "total_items": 1
}

Get information about all available segments for a specific list.

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.

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.

typestringOptional

Limit results based on segment type.

since_created_atstringOptional

Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_created_atstringOptional

Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

include_cleanedbooleanOptional

Include cleaned members in response

include_transactionalbooleanOptional

Include transactional members in response

include_unsubscribedbooleanOptional

Include unsubscribed members in response

since_updated_atstringOptional

Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_updated_atstringOptional

Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

exclude_typeenumOptional

Exclude results based on segment type. For example, use exclude_type=static to exclude tags from the response.

Allowed values:

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

list_idstringOptionalRead-only

The list id.

segmentslist of objectsOptional

An array of objects, each representing a list segment.

total_itemsintegerOptionalRead-only

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