Own Mailchimp? Customize your docs with AI search, analytics, and more.

Claim your docs

GET

Get segment info

https://mailchimp.com/lists/{list_id}/segments/{segment_id}

Get information about a specific segment.

Access Token Required: API Key

Path Parameters

list_idstringrequired

The unique ID for the list.

segment_idstringrequired

The unique id for the segment.

Query Params

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_cleanedstring

Include cleaned members in response

include_transactionalstring

Include transactional members in response

include_unsubscribedstring

Include unsubscribed members in response

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://mailchimp.com/lists/{list_id}/segments/{segment_id}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET