---
title: "List SCIM users"
method: GET
path: "/v0/scim/Users"
tags: ["SCIM"]
---

# List SCIM users

`GET /v0/scim/Users`

List SCIM users

## Query parameters

- `count` integer — Maximum number of results
- `filter` string — Optional filter like 'userName eq "bob@example.com"'
- `startIndex` integer — 1-indexed starting index

## Response `200`

OK

- HandlerTypesListSCIMUsersResponse
  - `Resources` HandlerTypesSCIMUser[]
    - `active` boolean
    - `emails` HandlerTypesSCIMEmail[]
      - `primary` boolean
      - `type` string
      - `value` string
    - `externalId` string, nullable — ID of the user in the external identity provider (e.g., Okta)
    - `id` string — ID of the user in Sublime
    - `meta` HandlerTypesSCIMMeta — Schema metadata
      - `created` string — DateTime when the resource was created
      - `lastModified` string — DateTime when the resource was last modified
      - `location` string — URL of the resource
      - `resourceType` string — Resource type
    - `name` HandlerTypesSCIMUserName, required
      - `familyName` string
      - `givenName` string
    - `schemas` string[]
    - `sublimeRole` string — Deprecated. For backwards-compatibility with existing integrations. Prefer the property on "urn:ietf:params:scim:schemas:extension:sublime:2.0:User"
    - `urn:ietf:params:scim:schemas:extension:sublime:2.0:User` HandlerTypesSCIMSublimeUserExtension
      - `sublimeRole` string — Sublime role of the user, such as 'admin', 'engineer', 'analyst', or a custom role
    - `userName` string, required
  - `itemsPerPage` integer
  - `schemas` string[]
  - `startIndex` integer
  - `totalResults` integer

---

[API](https://skmtc.net/sublime/apis/sublime-platform-api.md) · [All operations](https://skmtc.net/sublime/apis/sublime-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sublime/sublime-platform-api/versions/d5df82850357/schema)