Skip to main content
GET
/
scim
/
v2
/
embed
/
users
List embed users
curl --request GET \
  --url https://{instance}.omniapp.co/api/scim/v2/embed/users \
  --header 'Authorization: Bearer <token>'
{
  "Resources": [
    {
      "active": true,
      "displayName": "Blobby",
      "emails": [
        {
          "primary": true,
          "value": "embed-user-i_4TrNwyVTu34bZaC35VJVD3-pknp4YF7V8_Bi4TMdw@blobsrus.embed-exploreomni.co"
        }
      ],
      "groups": [
        {
          "display": "All Embed Users",
          "value": "4GcvQ2D9"
        },
        {
          "display": "Omni",
          "value": "nqGuU_uh"
        }
      ],
      "id": "2212aecf-a2ba-4d99-b23b-f615bc4c6522",
      "meta": {
        "created": "2024-09-30T20:25:01.822Z",
        "lastModified": "2024-09-30T20:51:47.558Z",
        "resourceType": "User"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "embed-user-i_4TrNwyVTu34bZaC35VJVD3-pknp4YF7V8_Bi4TMdw@blobsrus.embed-exploreomni.co",
      "embedEmail": null,
      "embedEntity": "omni",
      "embedExternalId": "blobby-manager"
    }
  ],
  "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 embed users using the userName or embedExternalId fields with SCIM operators.

OperatorDescriptionExample
eqExact matchuserName eq "blob.ross@blobsrus.co"
coContains substringembedExternalId co "sales"

Case sensitivity:

  • Attribute names (userName, embedExternalId) are case-insensitive
  • Operator names (eq, EQ, co, CO) are case-insensitive
  • Email comparisons are case-insensitive
  • External ID (embedExternalId) comparisons are case-sensitive, per SCIM spec

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

​
startIndex
integer
default:1

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

Response

List of embed users

​
Resources
object[]

The list of embed users

​
schemas
string[]

SCIM schema information for the response

​
itemsPerPage
integer

The number of embed users returned in the current page

​
totalResults
integer

The total number of embed users matching the query

​
startIndex
integer

The starting index of the current page in the result set