Get segment info

GET

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

Get information about a specific segment.

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

list_idstringRequired

The unique ID for the list.

segment_idstringRequired

The unique id for the segment.

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.

include_cleanedbooleanOptional

Include cleaned members in response

include_transactionalbooleanOptional

Include transactional members in response

include_unsubscribedbooleanOptional

Include unsubscribed members in response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

created_atdatetimeOptionalRead-only

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

idintegerOptionalRead-only

The unique id for the segment.

list_idstringOptionalRead-only

The list id.

member_countintegerOptionalRead-only

The number of active subscribers currently included in the segment.

namestringOptional

The name of the segment.

optionsobjectOptional

The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions.

typeenumOptionalRead-only

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

Allowed values:

updated_atdatetimeOptionalRead-only

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