Get Information About A List

post

https://api.transmitsms.com/get-list.json

Get detailed information about a list, return custom fields and its contacts. This will return paginated information regarding individual contacts on a list and their data.

Form Data

list_id

integer

required

Numeric ID assigned to the list being queried. List ID's can be retrieved using get-lists.

page

integer

Page number, for pagination.

max

integer

Maximum results returned per page.

members

boolean

Only show contacts with specific status. Returns all contacts if not specified.

VALUE	DESCRIPTION
active	Only return active contacts
inactive	Only return deleted contacts
none	Do not get contacts, just list metadata

response_style

string

'array' returns custom field lists as an array.

Response

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response containing information about the list and its members.