List users via SCIM v2.0

Changed on Sep 9, 2026

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 through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

get/v1/scim/v2/Users

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/scim/v2/Users
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token) and OAuth 2 (client credentials, token URL /auth/oauth2/token)

Query parameters

startIndexinteger

1-based index of the first result

countinteger

Maximum number of results per page

filterstring

Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge)

Response

Success

itemsPerPageinteger required

Number of results returned in the current set

schemasstring[] required

SCIM schema identifiers

startIndexinteger required

1-based index of the first result in the current set

totalResultsinteger required

Total number of results matching the query

Example response

{
  "Resources": [
    {
      "active": true,
      "displayName": "Johnny Doe",
      "emails": [
        {
          "primary": true,
          "type": "work",
          "value": "john.doe@example.com"
        }
      ],
      "id": "123456",
      "meta": {
        "created": "2023-01-01T00:00:00Z",
        "lastModified": "2023-01-01T00:00:00Z",
        "resourceType": "User"
      },
      "name": {
        "familyName": "Doe",
        "formatted": "John Doe",
        "givenName": "John",
        "honorificPrefix": "Mr"
      },
      "nickName": "Johnny",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Engineering",
        "employeeNumber": "EMP001",
        "manager": {
          "displayName": "Jane Manager",
          "value": "789012"
        }
      },
      "userName": "john.doe@example.com"
    }
  ],
  "itemsPerPage": 50,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 100
}

Changes

Sep 9, 202635ec3dcd7e49 Revision changes
- info
  the endpoint scheme security CustomerAPIToken AND OAuth2AuthorizationCode AND OAuth2ClientCredentials was added to the API
Jul 31, 202684c310d8394a Revision changes
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history