Skip to content

List Mailchimp audiences

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/account/integrations/mailchimp/audiences

Costs 1 rate-limit point · Rate limits

The Mailchimp audiences (lists) the saved Mailchimp API key can see, to pick mailchimp.list_id for PATCH /account/integrations.

Needs a saved Mailchimp key (POST /account/integrations/mailchimp/connect); without one the call fails with 422 invalid_params on mailchimp.api_key. Each call asks Mailchimp live and returns up to 100 audiences with id, name and member_count. When Mailchimp refuses the key, the call fails with 422 and Mailchimp's message. Read only: pass the chosen id as mailchimp.list_id in PATCH /account/integrations.

Also searched asmailchimp audiencesmailchimp lists

Returns

  • audiencesarray of objects
    Show 2 child attributesHide child attributes
    • idstring
      Example: string
    • namestring
      Example: string

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/account/integrations/mailchimp/audiences
curl "https://app.stoqapp.com/api/v2/external/account/integrations/mailchimp/audiences" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "audiences": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}