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

# List users

`GET /users`

## Request

- Base URL: `https://api.toriihq.com/v1.0`
- URL: `https://api.toriihq.com/v1.0/users`
- Auth: API key in header `Authorization`

Returns a list of users in the organization. Filtering is available via query parameters.

*   Rate limit: 100 requests per minute

## Query parameters

- `email` string
- `lifecycleStatus` 'active' | 'offboarding' | 'offboarded'
- `isDeletedInIdentitySources` boolean
- `isExternal` boolean
- `firstName` string
- `lastName` string
- `idUsers` string
- `sort` string
- `size` integer
- `cursor` string
- `aggs` string
- `fields` string
- `q` string
- `qFields` string
- `view` 'currentEmployees' | 'pastEmployees' | 'allEmployees' | 'currentUsers' | 'pastUsers' | 'allUsers' | 'currentNonHumanUsers' | 'pastNonHumanUsers' | 'allNonHumanUsers' | 'externalUsers'
- `filters` string

## Response `200`

Users

- Model15: Users
  - `users` User[]
    - `id` integer: Unique user identifier
    - `idOrg` integer: Unique org identifier
    - `firstName` string
    - `lastName` string
    - `email` string: Email address
    - `creationTime` string, date-time: Creation time
    - `idRole` number
    - `role` string
    - `lifecycleStatus` 'active' | 'offboarding' | 'offboarded': Lifecycle status
    - `isDeletedInIdentitySources` boolean: true if the user has left the organization, false otherwise
    - `isExternal` boolean: true if the user is external, false otherwise
    - `activeAppsCount` integer
    - `additionalEmails` string[]: List of additional emails
  - `aggregations` number
  - `count` integer: The number of results returned in this response
  - `total` integer: The total number of results
  - `nextCursor` string: A base64 string indicating the offset from which to start. <br>Pass the value of `nextCursor` returned from the previous call to get the next set of results

---

[API](https://skmtc.dev/toriihq/apis/torii-api-documentation.md) - [All operations](https://skmtc.dev/toriihq/apis/torii-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/toriihq/apis/torii-api-documentation/revisions/15fd1512591b?raw)