Get an opt-out list

Returns a single opt-out list, including how many opt-outs it contains.

GET

https://app.touchsms.com.au/api/v2/optout-lists/{optoutList}

Authorization

basicAuth
HTTP
required

Path parameters

optoutList
integer
required
Opt-out list ID.

Returns

200

The opt-out list.

JSON

data
optional
object
- id
  optional
  integer
- name
  optional
  string
- is_default
  optional
  boolean
  Whether this is your default opt-out list.
- opt_out_count
  optional
  integer
  Number of opt-outs in the list.
- created_at
  optional
  string
  format: date-time
- updated_at
  optional
  string
  format: date-time
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

JSON

message
string
required

Get an opt-out list

curl --request GET \
  --url https://app.touchsms.com.au/api/v2/optout-lists/2 \
  --header 'Authorization: Basic <credentials>'

const url = 'https://app.touchsms.com.au/api/v2/optout-lists/2';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "id": 2,
    "name": "Marketing Opt-Outs",
    "is_default": false,
    "opt_out_count": 89,
    "created_at": "2024-03-10T14:30:22.000000Z",
    "updated_at": "2024-03-15T09:45:18.000000Z"
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "This action is unauthorized."
}

{
  "message": "Not Found"
}