Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
User

List users

get/users

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:

ValueFormat
created_atdate-time
idint64
updated_atdate-time

Response

successful operation

total_entriesinteger

Example response

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