Query: List Members

Mailchimp Operation

The List Members query enables users to retrieve members of a specific list in Mailchimp.

Example User Story

As a marketer, I want to retrieve the members of a specific Mailchimp list so that I can analyze my audience.

Fields

Field Name	Field Type	Required
list_id	String	Yes
count	Integer	No
offset	Integer	No

Related Connections

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "get-list-members",
  "state": "inDev",
  "meta": {
    "short": "Get List Members",
    "description": "Retrieve members of a specific list in Mailchimp."
  },
  "input": [
    {
      "name": "list_id",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The unique ID for the list."
      }
    },
    {
      "name": "count",
      "type": "Integer",
      "required": false,
      "meta": {
        "description": "The number of records to return."
      }
    },
    {
      "name": "offset",
      "type": "Integer",
      "required": false,
      "meta": {
        "description": "The number of records from a collection to skip."
      }
    }
  ],
  "output": [
    {
      "name": "members",
      "type": "Array",
      "selector": ["members"],
      "meta": {
        "description": "An array of list members."
      }
    },
    {
      "name": "total_items",
      "type": "Integer",
      "selector": ["total_items"],
      "meta": {
        "description": "The total number of items matching the query."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "GET",
        "path": "/lists/{{list_id}}/members",
        "headers": {
          "Content-Type": "application/json"
        },
        "queryParams": {
          "count": "{{count}}",
          "offset": "{{offset}}"
        }
      }
    }
  ]
}