---
title: "List users via SCIM v2.0"
method: GET
path: "/v1/scim/v2/Users"
tags: ["SCIM"]
---

# List users via SCIM v2.0

`GET /v1/scim/v2/Users`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/scim/v2/Users`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token`
  - HTTP bearer

Retrieves a list of users for the authenticated company following SCIM 2.0 standard

## Authentication

This endpoint accepts any one of the following token types:

- **Company-scoped access token** (`OAuth2AuthorizationCode`) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Company-scoped access token (assertion)** (`OAuth2CompanyManagerAssertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant for a company manager. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion).
- **Client credentials access token** (`OAuth2ClientCredentials`) — obtained through the Client Credentials flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Customer API token** (`CustomerAPIToken`) — generated by the customer on their Integration Settings page, with the scopes they choose there. See [Authorization for customers](https://developer.remote.com/docs/authorization-for-customers).

## Query parameters

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

## Response `200`

Success

- IntegrationsScimUserListResponse
  - `Resources` IntegrationsScimUser[], required: Array of user resources
    - `active` boolean, required: Whether the user is active
    - `displayName` string: The name to display for the user
    - `emails` object[], required
      - `primary` boolean: Whether this is the primary email
      - `type` string, required: Type of email (e.g., 'work')
      - `value` string, required: Email address
    - `id` string, required: Unique identifier for the user
    - `meta` object
      - `created` string: Creation timestamp
      - `lastModified` string: Last modification timestamp
      - `resourceType` string: Resource type
    - `name` object, required
      - `familyName` string, required: Last name
      - `formatted` string: Full name
      - `givenName` string, required: First name
      - `honorificPrefix` string: Salutation, e.g. 'Ms', 'Mr'
    - `nickName` string: The casual/preferred name for the user
    - `schemas` string[], required: SCIM schema identifiers
    - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` object: Enterprise User extension attributes (RFC 7643 §4.3)
      - `department` string: Identifies the name of a department
      - `employeeNumber` string, nullable: Numeric or alphanumeric identifier assigned to a person
      - `manager` object: The user's manager
        - `$ref` string: The URI of the SCIM resource representing the user's manager
        - `displayName` string: The displayName of the user's manager
        - `value` string: The id of the SCIM resource representing the user's manager
    - `userName` string, required: Username for the user
  - `itemsPerPage` integer, required: Number of results returned in the current set
  - `schemas` string[], required: SCIM schema identifiers
  - `startIndex` integer, required: 1-based index of the first result in the current set
  - `totalResults` integer, required: Total number of results matching the query

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/remote-com/apis/integrations.md) - [All operations](https://skmtc.dev/remote-com/apis/integrations/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/integrations/revisions/1798c3c003d5?raw)