Integrations
SCIM

List groups via SCIM v2.0

Changed on

Retrieves a list of groups (departments) 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/Groups

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/scim/v2/Groups
  • 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": [
    {
      "displayName": "Engineering",
      "id": "engineering-dept",
      "members": [
        {
          "display": "John Doe",
          "value": "user-123-slug"
        }
      ],
      "meta": {
        "created": "2024-01-01T00:00:00Z",
        "lastModified": "2024-01-01T00:00:00Z",
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ]
    }
  ],
  "itemsPerPage": 10,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 10
}

Changes

  • 35ec3dcd7e49Revision changes
    • info

      the endpoint scheme security CustomerAPIToken AND OAuth2AuthorizationCode AND OAuth2ClientCredentials was added to the API