Skip to main content
GET
List embed users

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.

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

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