List opt-outs

Returns a paginated list of opt-outs across all of your opt-out lists, 100 per page.

GET

https://app.touchsms.com.au/api/v2/optouts

Authorization

basicAuth
HTTP
required

Query parameters

search
optional
string
Partial or whole phone number.
page
optional
integer
Page number. Prefer following links.next until it is null.

minimum: 1 · default: 1

Returns

200

A page of opt-outs.

JSON

data
optional
array of
object
- id
  optional
  integer
- user
  optional
  integer
  ID of the user that owns the opt-out.
- number
  optional
  string
  Opted-out number in E.164 format.
- method
  optional
  manual
  or
  import
  or
  link
  or
  reply
  or
  chat
  or
  api
  +2 more
  How the opt-out was created.
- opt_out_list
  optional
  object
  The list this opt-out belongs to.
  
  id
  optional
  integer
  name
  optional
  string
  is_default
  optional
  boolean
- updated
  optional
  string
  format: date-time
- created
  optional
  string
  format: date-time
}
links
optional
object
Links to other pages. next is null on the last page.
- first
  optional
  string | null
  format: uri
- last
  optional
  string | null
  format: uri
- prev
  optional
  string | null
  format: uri
- next
  optional
  string | null
  format: uri
}
meta
optional
object
Position in the result set. Read per_page rather than assuming a page size.
- current_page
  optional
  integer
- from
  optional
  integer | null
- last_page
  optional
  integer
- path
  optional
  string
  format: uri
- per_page
  optional
  integer
- to
  optional
  integer | null
- total
  optional
  integer
- links
  optional
  array of
  object
  Page links for building pagination controls.
  
  url
  optional
  string | null
  label
  optional
  string
  active
  optional
  boolean
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

{ "data": [ { "id": 12345, "user": 5678, "number": "+61412345678", "method": "reply", "opt_out_list": { "id": 1, "name": "Default Opt-Out List", "is_default": true }, "updated": "2024-03-11T02:14:07.000000Z", "created": "2024-03-11T02:14:07.000000Z" } ], "links": { "first": "https://app.touchsms.com.au/api/v2/contacts?page=1", "last": "https://app.touchsms.com.au/api/v2/contacts?page=8", "prev": null, "next": "https://app.touchsms.com.au/api/v2/contacts?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 8, "path": "https://app.touchsms.com.au/api/v2/contacts", "per_page": 50, "to": 50, "total": 400 } }