List contacts

Returns a paginated list of contacts, sorted by first name by default.

GET

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

Authorization

basicAuth
HTTP
required

Query parameters

search
optional
string
Search term.
sort_by
optional
id
or
firstname
or
surname
or
created
Field to sort by.

default: "firstname"
sort_order
optional
asc
or
desc
Sort direction.

default: "asc"
per_page
optional
integer
Results per page.

maximum: 200 · minimum: 10 · default: 50
page
optional
integer
Page number. Prefer following links.next until it is null.

minimum: 1 · default: 1

Returns

200

A page of contacts.

JSON

data
optional
array of
object
- id
  optional
  integer
- user
  optional
  integer
  ID of the user that owns the contact.
- firstname
  optional
  string | null
- surname
  optional
  string | null
- email
  optional
  string | null
- number
  optional
  string
- metadata
  optional
  object | null
- groups
  optional
  array of
  object
  id
  optional
  integer
  name
  optional
  string
- notes
  optional
  array of
  object
  Notes on the contact. Only returned when getting or updating a single contact.
  
  id
  optional
  integer
  content
  optional
  string
  created_at
  optional
  string
  format: date-time
  updated_at
  optional
  string
  format: date-time
- 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

422

The request failed validation. errors lists the messages for each invalid field.

JSON

message
optional
string
errors
optional
map of
array<string>

{ "data": [ { "id": 4040, "user": 5678, "firstname": "Sam", "surname": "Taylor", "email": "sam@example.com", "number": "+61412345678", "metadata": null, "groups": [ { "id": 512, "name": "Customers" } ], "updated": "2024-03-11T02:14:07Z", "created": "2024-02-02T23:51:19Z" } ], "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 } }