---
title: "Get merge field"
method: GET
path: "/3.0/lists/{list_id}/merge-fields/{merge_id}"
tags: ["lists"]
---

# Get merge field

`GET /3.0/lists/{list_id}/merge-fields/{merge_id}`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/lists/{list_id}/merge-fields/{merge_id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/lists/:list_id/merge-fields/:merge_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get information about a specific merge field.

## Path parameters

- `list_id` string, required
- `merge_id` string, required

## Query parameters

- `exclude_fields` string[]
- `fields` string[]

## Response `200`

- object: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.
  - `_links` object[]: A list of link types and descriptions for the API schema documents.
    - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
    - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
    - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
    - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
  - `default_value` string: The default value for the merge field if `null`.
  - `display_order` integer: The order that the merge field displays on the list signup form.
  - `help_text` string: Extra text to help the subscriber fill out the form.
  - `list_id` string: The ID that identifies this merge field's audience'.
  - `merge_field_limit` integer: The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Returned on POST responses only. Subtract `total_items` from this value to derive the remaining capacity.
  - `merge_id` integer: An unchanging id for the merge field.
  - `name` string: The name of the merge field (audience field).
  - `options` object: Extra options for some merge field types.
    - `choices` string[]: In a radio or dropdown non-group field, the available options for contacts to pick from.
    - `date_format` string: In a date or birthday field, the format of the date.
    - `default_country` integer: In an address field, the default country code if none supplied.
    - `phone_format` string: In a phone field, the phone number type: US or International.
    - `size` integer: In a text field, the default length of the text field.
  - `public` boolean: Whether the merge field is displayed on the signup form.
  - `required` boolean: The boolean value if the merge field is required.
  - `tag` string: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts).
  - `total_items` integer: The total number of merge fields on the audience after this field was created. Returned on POST responses only.
  - `type` 'text' | 'number' | 'address' | 'phone' | 'date' | 'url' | 'imageurl' | 'radio' | 'dropdown' | 'birthday' | 'zip': The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.

## Other responses

- `default`: An error generated by the Mailchimp API.

---

[API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)