KUkudosity
Reporting

Get Information About A List

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.

post/get-list.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

list_idinteger required

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

pageinteger

Page number, for pagination.

maxinteger

Maximum results returned per page.

membersboolean

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
response_stylestring

'array' returns custom field lists as an array.

Response

Successful response containing information about the list and its members.

members_totalinteger

Count of number of contacts on list. This will include deleted contacts.

idinteger

Numeric ID of the list.

namestring

Name of the list.

createdstring date-time

Date list was first created. Returned in ISO8601 format YYYY-MM-DD HH:MM:SS in UTC Timezone.

members_activeinteger

Count of active contacts on list.

fieldsstring[]

List of custom field names.

Changes

No recorded changes to this operation across all 2 revisions of this API.