Lists

Get contact lists

Get the contact lists for the account

get/get-lists/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/get-lists/
  • Auth: one of:
    • API key in query parameter key
    • HTTP basic

Query parameters

keystring required

API Key as generated from the <a href='https://www.smsfusion.com.au/admin/api/'>admin panel</a>

readonlyboolean

Include readonly lists (e.g. the Global Optout suppression list) in the response

Response

Successfull response

idstring

List ID. Values are numeric strings - the API emits this field as a JSON string, not a number

createdinteger

Unix timestamp the list was created

namestring

List name

readonlyboolean

Whether this is a system-managed readonly list (e.g. the Global Optout suppression list). Readonly lists are excluded from the response entirely unless the readonly parameter was set

unsublistboolean

Whether the list is used as an unsubscribe/suppression list

countinteger

Number of contacts in the list

Example response

[
  {
    "id": "42",
    "name": "My Contacts"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.