--- title: "List members info" method: GET path: "/3.0/lists/{list_id}/members" tags: ["lists"] --- # List members info `GET /3.0/lists/{list_id}/members` ## Request - Base URL: `https://api.mailchimp.com` - URL: `https://api.mailchimp.com/3.0/lists/{list_id}/members` - Auth: one of: - HTTP bearer - OAuth 2 - Authorization code: `https://login.mailchimp.com/oauth2/authorize` - Token URL: `https://login.mailchimp.com/oauth2/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Get information about members in a specific Mailchimp list. ## Path parameters - `list_id` string, required ## Query parameters - `fields` string[] - `exclude_fields` string[] - `count` integer - `offset` integer - `email_type` string - `status` 'subscribed' | 'unsubscribed' | 'cleaned' | 'pending' | 'transactional' | 'archived' - `since_timestamp_opt` string - `before_timestamp_opt` string - `since_last_changed` string - `before_last_changed` string - `unique_email_id` string - `vip_only` boolean - `interest_category_id` string - `interest_ids` string - `interest_match` 'any' | 'all' | 'none' - `sort_field` 'timestamp_opt' | 'timestamp_signup' | 'last_changed' - `sort_dir` 'ASC' | 'DESC' - `since_last_campaign` boolean - `unsubscribed_since` string ## Response `200` - object: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. - `_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. - `list_id` string: The list id. - `members` object[]: An array of objects, each representing a specific list member. - `_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. - `consents_to_one_to_one_messaging` boolean: Indicates whether a contact consents to 1:1 messaging. - `contact_id` string: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. - `email_address` string: Email address for a subscriber. - `email_client` string: The list member's email client. - `email_type` unknown - `id` string: The MD5 hash of the lowercase version of the list member's email address. - `interests` object: The key of this object's properties is the ID of the interest in question. - `ip_opt` string: The IP address the subscriber used to confirm their opt-in status. - `ip_signup` string: IP address the subscriber signed up from. - `language` string: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). - `last_changed` string, date-time: The date and time the member's info was last changed in ISO 8601 format. - `last_note` object: The most recent Note added about this member. - `created_at` string, date-time: The date and time the note was created in ISO 8601 format. - `created_by` string: The author of the note. - `note` string: The content of the note. - `note_id` integer: The note id. - `list_id` string: The list id. - `location` object: Subscriber location information. - `country_code` string: The unique code for the location country. - `dstoff` integer: The offset for timezones where daylight saving time is observed. - `gmtoff` integer: The time difference in hours from GMT. - `latitude` number: The location latitude. - `longitude` number: The location longitude. - `region` string: The region for the location. - `timezone` string: The timezone for the location. - `marketing_permissions` object[]: The marketing permissions for the subscriber. - `enabled` boolean: If the subscriber has opted-in to the marketing permission. - `marketing_permission_id` string: The id for the marketing permission on the list - `text` string: The text of the marketing permission. - `member_rating` integer: Star rating for this member, between 1 and 5. - `merge_fields` object, nullable: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. - `sms_phone_number` string: A US phone number for SMS contact. - `sms_subscription_last_updated` string: The datetime when the SMS subscription was last updated - `sms_subscription_status` 'subscribed' | 'unsubscribed' | 'nonsubscribed' | 'pending': The status of an SMS subscription. - `source` string: The source from which the subscriber was added to this list. - `stats` object: Open and click rates for this subscriber. - `avg_click_rate` number: A subscriber's average clickthrough rate. - `avg_open_rate` number: A subscriber's average open rate. - `ecommerce_data` object: Ecommerce stats for the list member if the list is attached to a store. - `currency_code` string: The three-letter ISO 4217 code for the currency that the store accepts. - `number_of_orders` number: The total number of orders placed by the list member. - `total_revenue` number: The total revenue the list member has brought in. - `status` 'subscribed' | 'unsubscribed' | 'cleaned' | 'pending' | 'transactional' | 'archived': Subscriber's current status. - `tags` object[]: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). - `id` integer: The tag id. - `name` string: The name of the tag - `tags_count` integer: The number of tags applied to this member. - `timestamp_opt` string, date-time: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. - `timestamp_signup` string, date-time: The date and time the subscriber signed up for the list in ISO 8601 format. - `unique_email_id` string: An identifier for the address across all of Mailchimp. - `unsubscribe_reason` string: A subscriber's reason for unsubscribing. - `vip` boolean: [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. - `web_id` integer: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. - `total_items` integer: The total number of items matching the query regardless of pagination. ## 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)