MAmailchimp
lists

List segments

Get information about all available segments for a specific list.

get/3.0/lists/{list_id}/segments

Request

Path parameters

list_idstring required

The unique ID for the list.

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

offsetinteger

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

typestring

Limit results based on segment type.

since_created_atstring

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

before_created_atstring

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

include_cleanedboolean

Include cleaned members in response

include_transactionalboolean

Include transactional members in response

include_unsubscribedboolean

Include unsubscribed members in response

since_updated_atstring

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

before_updated_atstring

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

exclude_type'saved' | 'static' | 'fuzzy'

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

Response

list_idstring

The list id.

total_itemsinteger

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

Example response

{
  "segments": [
    {
      "options": {
        "conditions": [
          {
            "field": "aim",
            "op": "open",
            "value": "any"
          }
        ]
      }
    }
  ]
}

Changes

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