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

Claim your docs

GET

List merge fields

https://mailchimp.com/lists/{list_id}/merge-fields

Get a list of all merge fields for an audience.

Access Token Required: API Key

Path Parameters

list_idstringrequired

The unique ID for the list.

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.

countstring

The number of records to return. Default value is 10. Maximum value is 1000

offsetstring

Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.

typestring

The merge field type.

requiredstring

Whether it's a required merge field.

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}/merge-fields' \
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