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

# List users

`GET /api/users`

List users, paginated and ordered by their name (alphabetical order).

## Query parameters

- `cursor` string
- `external_id` string
- `email` string
- `limit` integer
- `order_by` 'created_datetime:asc' | 'created_datetime:desc' | 'name:asc' | 'name:desc' | 'email:asc' | 'email:desc' | 'role.name:asc' | 'role.name:desc'
- `roles` string[]
- `search` string
- `available_first` boolean

## Response `200`

A list of users.

- User[]
  - `id` integer — ID of the user.
  - `active` boolean — Whether the user can log in.
  - `bio` string — Short biography of the user.
  - `created_datetime` string, date-time — When the user was created.
  - `country` string, ISO 3166-1 alpha-2 — Country of the user
  - `deactivated_datetime` string, date-time — When the user was deactivated.
  - `email` string, email — Email address of the user. `password_confirmation` field must be provided to change the email.
  - `external_id` string — ID of the user in a foreign system (Stripe, Aircall, etc...). This field is not used by Gorgias, feel free to set it as you wish.
  - `firstname` string — First name of the user.
  - `lastname` string — Last name of the user.
  - `language` string — Language of the user.
  - `meta` object — Data associated with the user. You can use this field to store structured information (key-value data) about the user.
    - `sso` 'google' | 'office365', nullable — Name of the Single Sign-On provider the user can use to log in
    - `profile_picture_url` string, url, nullable — URL of the profile picture of the user
  - `name` string — Full name of the user.
  - `role` object — The role of the user.
    - `name` 'admin' | 'agent' | 'basic-agent' | 'bot' | 'internal-agent' | 'lite-agent' | 'observer-agent' — Name of the role
  - `timezone` string — Timezone of the user.
  - `updated_datetime` string, date-time — When the user was last updated.
  - `client_id` string — Service account associated application ID.

---

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