---
title: "List users"
method: GET
path: "/users"
tags: ["User"]
---

# List users

`GET /users`

## Query parameters

- `page` integer
- `per_page` integer
- `sort` string[]
- `order` 'asc' | 'desc'
- `q[]` string[]

## Response `200`

successful operation

- object
  - `users` User[]
    - `active` boolean, nullable
    - `created_at` string, date-time
    - `email` string
    - `first_name` string
    - `id` string, int64
    - `last_name` string
    - `links` object
      - `self` string, uri
    - `phone_numbers` PhoneNumber[], nullable
      - `normalized_number` string, phone
      - `number` string, phone
      - `phone_type` 'Fax' | 'Home' | 'Mobile' | 'Other' | 'Work'
    - `role` 'administrator' | 'bookkeeper' | 'power receptionist' | 'practitioner' | 'receptionist' | 'scheduler'
    - `time_zone` string — See: [supported time zones](/guides/time_zone_support/#accepted-values-for-time_zone)
    - `time_zone_identifier` string, nullable — See: [supported time zone identifiers](/guides/time_zone_support/#accepted-values-for-time_zone_identifier)
    - `title` string, nullable
    - `updated_at` string, date-time
    - `user_active` boolean, nullable
  - `total_entries` integer
  - `links` object
    - `self` string, uri
    - `previous` string, uri
    - `next` string, uri

---

[API](https://skmtc.net/cliniko/apis/cliniko-api.md) · [All operations](https://skmtc.net/cliniko/apis/cliniko-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cliniko/cliniko-api/versions/c129a555ff44/schema)