> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List SCIM users

> SCIM 2.0 endpoint that lists the organization's provisioned users. An identity provider calls this during a sync to reconcile its directory against Orbit. Supports the `filter` (e.g. `userName eq "ada@example.com"`), `startIndex`, and `count` query parameters for pagination (max 500 per page). Authenticated with the organization's SCIM bearer token.



## OpenAPI

````yaml /openapi.yaml get /scim/v2/{orgSlug}/Users
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /scim/v2/{orgSlug}/Users:
    get:
      summary: List SCIM users
      description: >-
        SCIM 2.0 endpoint that lists the organization's provisioned users. An
        identity provider calls this during a sync to reconcile its directory
        against Orbit. Supports the `filter` (e.g. `userName eq
        "ada@example.com"`), `startIndex`, and `count` query parameters for
        pagination (max 500 per page). Authenticated with the organization's
        SCIM bearer token.
      parameters:
        - schema:
            type: string
          in: path
          name: orgSlug
          required: true
          description: The organization slug that scopes the SCIM tenant.
        - schema:
            type: string
          in: query
          name: filter
          required: false
          description: >-
            SCIM filter expression, for example userName eq a specific email
            address.
        - schema:
            type: integer
          in: query
          name: startIndex
          required: false
          description: 1-based index of the first result to return.
        - schema:
            type: integer
          in: query
          name: count
          required: false
          description: Maximum number of results to return, from 1 to 500.
      responses:
        '200':
          description: A SCIM ListResponse containing the organization's users.
          content:
            application/scim+json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  totalResults:
                    type: integer
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
                  Resources:
                    type: array
                    items:
                      type: object
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                totalResults: 1
                startIndex: 1
                itemsPerPage: 1
                Resources:
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: user_2a3b4c5d
                    userName: ada@example.com
                    name:
                      givenName: Ada
                      familyName: Lovelace
                      formatted: Ada Lovelace
                    emails:
                      - value: ada@example.com
                        primary: true
                        type: work
                    displayName: Ada Lovelace
                    active: true
                    meta:
                      resourceType: User
                      location: https://api.orbit.devotel.io/scim/v2/Users/user_2a3b4c5d
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````