List merge fields

GET

https://api.mailchimp.com/3.0/lists/:list_id/merge-fields

GET

/3.0/lists/:list_id/merge-fields

curl https://api.mailchimp.com/3.0/lists/list_id/merge-fields \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "list_id": "string",
  "merge_field_limit": 30,
  "merge_fields": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "default_value": "string",
      "display_order": 1,
      "help_text": "string",
      "list_id": "string",
      "merge_field_limit": 30,
      "merge_id": 1,
      "name": "string",
      "options": {
        "choices": [
          "First Choice",
          "Second Choice",
          "Third Choice"
        ],
        "date_format": "string",
        "default_country": 1,
        "phone_format": "string",
        "size": 1
      },
      "public": true,
      "required": true,
      "tag": "string",
      "total_items": 28,
      "type": "text"
    }
  ],
  "total_items": 1
}

Get a list of all merge fields for an audience.

Authentication

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

Path parameters

list_idstringRequired

The unique ID for the list.

Query parameters

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.

countintegerOptional<=1000Defaults to 10

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

offsetintegerOptionalDefaults to 0

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

typestringOptional

The merge field type.

requiredbooleanOptional

Whether it's a required merge field.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

list_idstringOptionalRead-only

The list id.

merge_field_limitintegerOptionalRead-only

The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Subtract total_items from this value to derive the remaining capacity.

merge_fieldslist of objectsOptional

An array of objects, each representing a merge field resource.

total_itemsintegerOptionalRead-only

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