API & Integrations | Lists

This method returns all lists (ids and names) from a particular brand.

URL
https://mailcup.net/api/lists/get-lists

PARAMETERS (POST)

1. api_key your API key, available in Settings.
2. brand_id the id of the brand you want to get the list of lists from. Brand IDs can be found under 'Brands' page named ID.
3. include_hidden if you want to retrieve lists that are hidden as well, set this to yes. Default is no.

RESPONSE (JSON)

Success: You'll get a list of lists (ids and names) in JSON format

Error: No data passed

Error: API key not passed

Error: Invalid API key

Error: Brand ID not passed

Error: Brand does not exist

Error: No lists found