Skip to navigation
API ReferenceLists

List interest categories

Get information about a list’s interest categories.

Authentication

AuthorizationBearer

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

OR
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
Restrict results a type of interest group
sort_fieldenumOptional

Returns interest categories sorted by the specified field. Defaults to display_order.

Allowed values:
sort_direnumOptional
Determines the order direction for sorted results.
Allowed values:

Response

This endpoint returns an object.
categorieslist of objectsOptional
This array contains individual interest categories.
list_idstringOptionalRead-only
The ID for the list that this category belongs to.
total_itemsintegerOptionalRead-only
The total number of items matching the query regardless of pagination.