---
title: "Get All Users"
method: GET
path: "/Users"
tags: ["Users"]
---

# Get All Users

`GET /Users`

## Request

- Base URL: `https://users.lucid.app/scim/v2`
- URL: `https://users.lucid.app/scim/v2/Users`
- Auth: HTTP bearer

Gets all users on an account.

## Query parameters

- `startIndex` number
- `count` number
- `filter` string
- `attributes` string[]
- `excludedAttributes` string[]

## Response `200`

OK. Returns a JSON object containing a list of users. Deactivated users will not be included in the totalResults or the JSON payload of users returned.

- GetAllUsers
  - `schemas` string[]
  - `totalResults` integer: The total number of users matching the query.
  - `startIndex` integer: The index of the first user in the "Resources" list (for paginated results).
  - `itemsPerPage` integer: The maximum number of users returned in the "Resources" list (for paginated results).
  - `Resources` User[]: The list of users returned by the query.
    - `schemas` string[]: URIs identifying the SCIM schemas that describe this resource's attributes.
    - `userName` string: The user's username (usually their email).
    - `name` Name: An object representing a user's name in various formats.
      - `formatted` string: The users first and last name.
      - `givenName` string: The user's first name.
      - `familyName` string: The user's last name.
    - `displayName` string: The name that is displayed and represents the user (usually their email).
    - `emails` Email[]
      - `value` string: The user's email.
      - `type` string: A label indicating the attribute's function (e.g., 'work' or 'home').
      - `primary` boolean: Used to determine the primary email of the emails given.
    - `active` boolean: Whether the user can authenticate to Lucid.
    - `externalId` string: An identifier for the user as defined by the provisioning client.
    - `title` string: The user's job title.
    - `phoneNumbers` PhoneNumber[]: A list of phone numbers for the user. Currently only "work" type phone numbers are supported.
      - `value` string: The phone number.
      - `type` string: The type of phone number (e.g., work, home, mobile). Only "work" type is currently supported.
    - `meta` object
    - `roles` Role[]: A list of administrative roles assigned to the user. Assigning a role to a user allows that user to perform administrative actions associated with that role.
      - `value` 'AccountAdmin' | 'BillingAdmin' | 'Developer' | 'DocumentAdmin' | 'EnterpriseShieldAdmin' | 'TemplateAdmin', required: Administrative role type.
    - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` EnterpriseUserExtension: Enterprise extension attributes for the user.
      - `costCenter` string: The cost center associated with the user.
      - `organization` string: The organization that the user belongs to.
      - `division` string: The division that the user belongs to.
      - `department` string: The department that the user belongs to.
      - `manager` object: The user's manager.
        - `value` string: The ID of the manager user. Will be in the form "lucid-1234" with 1234 being the ID of the Lucid user.
    - `id` string: Will be in the form "lucid-1234" with 1234 being the ID of the Lucid user.
    - `groups` UserGroup[]
      - `value` string: Id of group.
      - `display` string: Display name of group.

## Other responses

- `400`: Bad Request. Occurs if the filter parameter has invalid syntax or uses unsupported operators.
- `401`: Unauthorized. Occurs if bearer token is invalid.
- `429`: Too Many Requests. Wait at least the number of seconds indicated by Retry-After before retrying. Increase the delay after repeated 429 responses and limit the number of retries.

---

[API](https://skmtc.dev/lucid/apis/lucid-scim-api.md) - [All operations](https://skmtc.dev/lucid/apis/lucid-scim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lucid/apis/lucid-scim-api/revisions/840cb3f88aa6?raw)