List interests in category

GET

https://api.mailchimp.com/3.0/lists/:list_id/interest-categories/:interest_category_id/interests

GET

/3.0/lists/:list_id/interest-categories/:interest_category_id/interests

curl https://api.mailchimp.com/3.0/lists/list_id/interest-categories/interest_category_id/interests \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "category_id": "string",
  "interests": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "category_id": "string",
      "display_order": 1,
      "id": "string",
      "list_id": "string",
      "name": "string",
      "subscriber_count": "string"
    }
  ],
  "list_id": "string",
  "total_items": 1
}

Get a list of this category’s interests.

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.

interest_category_idstringRequired

The unique ID for the interest category.

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.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

category_idstringOptional

The id for the interest category.

interestslist of objectsOptional

An array of this category's interests

list_idstringOptional

The unique list id that the interests belong to.

total_itemsintegerOptionalRead-only

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