Skip to main content
GET
/
scim
/
v2
/
embed
/
users
List embedded users
curl --request GET \
  --url https://{instance}.omniapp.co/api/scim/v2/embed/users \
  --header 'Authorization: Bearer <token>'
{
  "Resources": [
    {
      "embedExternalId": "<string>",
      "embedEntity": "<string>",
      "embedEmail": "<string>"
    }
  ],
  "itemsPerPage": 123,
  "totalResults": 123,
  "startIndex": 123
}

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 by embedExternalId or userName

count
integer
default:100

Number of results per page

startIndex
integer
default:1

Starting index for pagination

Response

List of embedded users

Resources
object[]
itemsPerPage
integer
totalResults
integer
startIndex
integer