API Reference

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
integer
required

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

integer

Page number, for pagination.

integer

Maximum results returned per page.

boolean

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

VALUEDESCRIPTION
activeOnly return active contacts
inactiveOnly return deleted contacts
noneDo not get contacts, just list metadata
string

'array' returns custom field lists as an array.

Response

Updated 9 days ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago