MAmailchimp
lists

Get segment info

Get information about a specific segment.

get/3.0/lists/{list_id}/segments/{segment_id}

Request

Path parameters

list_idstring required

The unique ID for the list.

segment_idstring required

The unique id for the segment.

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.

include_cleanedboolean

Include cleaned members in response

include_transactionalboolean

Include transactional members in response

include_unsubscribedboolean

Include unsubscribed members in response

Response

created_atstring date-time

The date and time the segment was created in ISO 8601 format.

idinteger

The unique id for the segment.

list_idstring

The list id.

member_countinteger

The number of active subscribers currently included in the segment.

namestring

The name of the segment.

type'saved' | 'static' | 'fuzzy'

The type of segment. Static segments are now known as tags. Learn more about tags.

updated_atstring date-time

The date and time the segment was last updated in ISO 8601 format.

Example response

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

Changes

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