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

# List users

`GET /scim/v2/users`

List users in the organization, sorted by creation time. Use the [embed users](/api/users/list-embed-users) endpoint to retrieve embed users.

## Query parameters

- `filter` string
- `count` integer
- `startIndex` integer

## Response `200`

List of users

- object
  - `Resources` ScimUser[] — The list of users
    - `id` string — Unique identifier for the user
    - `userName` string — The user's email address
    - `displayName` string — The user's display name
    - `active` boolean — Whether the user is active
    - `emails` object[] — The user's email addresses
      - `primary` boolean — Whether this is the user's primary email
      - `value` string — The email address
    - `groups` object[] — User groups that the user belongs to
      - `display` string — The group's display name
      - `value` string — The group's unique identifier
    - `meta` object
      - `resourceType` string — The resource type. This will be `User`.
      - `created` string, date-time — The time the user was created
      - `lastModified` string, date-time — The time the user was last updated
    - `schemas` string[] — SCIM information about the type of schemas used in the API. For example, `urn:ietf:params:scim:schemas:core:2.0:User`
    - `urn:omni:params:1.0:UserAttribute` object — [User attributes](/administration/users/attributes) as key/value pairs, where keys map to the IDs of user attributes defined in Omni. This is the **Reference** column in the **User attributes** page.
    - `urn:omni:params:scim:schemas:extension:user:2.0` object — Omni SCIM extension schema containing additional user metadata
      - `lastLogin` string, date-time, nullable — The timestamp of the user's last login. Will be `null` if the user has never logged in.
  - `schemas` string[] — SCIM schema information for the response
  - `itemsPerPage` integer — The number of users returned in the current page
  - `totalResults` integer — The total number of users matching the query
  - `startIndex` integer — The starting index of the current page in the result set

## Other responses

- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

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