Get user by ID via SCIM v2.0

Changed on Sep 9, 2026

Retrieves a single user for the authenticated company by user ID

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/{id}

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/scim/v2/Users/{id}
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)

Path parameters

idstring required

User ID (slug)

Response

Success

activeboolean required

Whether the user is active

displayNamestring

The name to display for the user

idstring required

Unique identifier for the user

nickNamestring

The casual/preferred name for the user

schemasstring[] required

SCIM schema identifiers

userNamestring required

Username for the user

Example response

{
  "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"
}

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