v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Contact

List contacts

get/contacts

Query parameters

pageinteger

per_pageinteger

sortstring[]

Comma separated search fields. See: Ordering

[
  "created_at:desc"
]

order'asc' | 'desc'

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
company_name	string
created_at	date-time
deleted_at	date-time
email	string
first_name	string
id	int64
last_name	string
occupation	string
type_code	integer
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "contacts": [
    {
      "country_code": "AU",
      "links": {
        "self": "https://api.au1.cliniko.com/v1/contacts/1"
      },
      "phone_numbers": [
        {
          "normalized_number": "39012345678",
          "number": "0-123-456-78"
        }
      ]
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/contacts?page=2",
    "previous": "https://api.au1.cliniko.com/v1/contacts?page=1",
    "next": "https://api.au1.cliniko.com/v1/contacts?page=3"
  }
}