Skip to main content
GET
/
scim
/
v2
/
users
List users
curl --request GET \
  --url https://{instance}.omniapp.co/api/scim/v2/users \
  --header 'Authorization: Bearer <token>'
{
  "Resources": [
    {
      "active": true,
      "displayName": "Blob Ross",
      "emails": [
        {
          "primary": true,
          "value": "blob.ross@blobsrus.co"
        }
      ],
      "groups": [],
      "id": "9e8719d9-276a-4964-9395-a493189a247c",
      "meta": {
        "created": "2024-11-04T16:01:47.015Z",
        "lastModified": "2024-11-04T16:05:45.356Z",
        "resourceType": "User"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:omni:params:1.0:UserAttribute",
        "urn:omni:params:scim:schemas:extension:user:2.0"
      ],
      "userName": "blob.ross@blobsrus.co",
      "urn:omni:params:scim:schemas:extension:user:2.0": {
        "lastLogin": "2024-01-03T00:00:00.000Z"
      }
    }
  ],
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Query Parameters

​
filter
string

Filter users using the userName field with SCIM operators:

OperatorDescriptionExample
eqExact matchuserName eq "blob.ross@blobsrus.co"
coContains substringuserName co "smith"

Case sensitivity:

  • Attribute names (userName, USERNAME) are case-insensitive
  • Operator names (eq, EQ, co, CO) are case-insensitive
  • Email comparisons are case-insensitive

Usernames should be URL-encoded when passed as filters. For example, userName eq "user@example.com" will become userName%20eq%20%22user%40example.com%22 when encoded.

​
count
integer
default:100

The number of users to return per page

​
startIndex
integer
default:1

An integer index that determines the starting point of the sorted result list

Response

List of users

​
Resources
object[]

The list of users

​
schemas
string[]

SCIM schema information for the response

​
itemsPerPage
integer

The number of users returned in the current page

​
totalResults
integer

The total number of users matching the query

​
startIndex
integer

The starting index of the current page in the result set