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

# List Users

`GET /Users`

## Request

- Base URL: `https://api.oneflow.com/scim/v1`
- URL: `https://api.oneflow.com/scim/v1/Users`
- Auth: HTTP bearer

Use this endpoint to get the list of users.

## Query parameters

- `sortBy` string
- `sortOrder` 'ascending' | 'descending'
- `startIndex` integer
- `count` integer
- `attributes` string
- `excludedAttributes` string
- `filter` string

## Response `200`

Returns the list of users, optionally user attributes are filtered by attributes or excludedAttributes parameters.

- UsersList: Represents list of users.
  - `itemsPerPage` integer: The number of resources returned in a list response page.
  - `Resources` User[], required: A list of the Users.
    - `active` boolean: Indicates if the user is active/enabled.
    - `displayName` string: The name of the user, suitable for display to end-users.
    - `name` object: Compatibility attribute, writes are allowed but discarded. Empty strings when read from.
      - `formatted` string
      - `familyName` string
      - `givenName` string
      - `middleName` string
      - `honorificPrefix` string
      - `honorificSuffix` string
    - `password` string: Compatibility attribute. Write-only, never returned. Writes are discarded.
    - `roles` object[]
      - `type` string, nullable: Type Identifier
      - `display` string, nullable: Roles display name
      - `value` string: Roles value
      - `primary` boolean: Roles primary
    - `externalId` string, nullable: A custom, user-supplied ID.
    - `groups` object[]: A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.
      - `display` string, nullable: Compatibility field, accepted but discarded.
      - `type` string: The name of the resource type of the resource. Always 'Group.'
      - `value` string: The ID of the group.
      - `x-ref` string: The URI of the corresponding "Group" resources to which the user belongs.
    - `id` string: The ID of this resource instance.
    - `locale` string: Indicate the User's default location for purposes of localization. It is the language tag only (no region).
    - `meta` object, nullable: An object containing user metadata properties.
      - `created` string, datetime: The time when the user was created.
      - `lastModified` string, datetime: The time when the user was last modified.
      - `location` string: The URI of the user being returned.
      - `resourceType` string: The name of the resource type of the resource. Always 'User.'
    - `phoneNumbers` object[]: Phone numbers for the user.
      - `primary` boolean: Whether or not the phone number is the user's primary phone number.
      - `value` string, nullable: The user's phone number.
      - `type` string: The phone number type.
    - `schemas` string[]: A schema for representing the user's configuration.
    - `title` string, nullable: The user's title.
    - `userName` string: A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider.
  - `schemas` string[]: A schema for representing the resource list configuration.
  - `startIndex` integer: The 1-based index of the first result in the current set of list results.
  - `totalResults` integer, required: The total number of results returned by the list or query operation.

## Other responses

- `401`: The SCIM token is invalid.

---

[API](https://skmtc.dev/oneflow/apis/scim-api-for-oneflow.md) - [All operations](https://skmtc.dev/oneflow/apis/scim-api-for-oneflow/llms.txt) - [OpenAPI document](https://skmtc.dev/oneflow/apis/scim-api-for-oneflow/revisions/4373300e62fb?raw)