v1
latestOpenAPI 3.1.02026-07-2618690613.4 KBUsers
List embed users
List embed users in the organization, sorted by creation time. Use the users endpoint to retrieve standard users.
get/scim/v2/embed/users
Query parameters
filterstring
Filter embed users using the userName or embedExternalId fields with SCIM operators.
| Operator | Description | Example |
|---|---|---|
| eq | Exact match | userName eq "blob.ross@blobsrus.co" |
| co | Contains substring | embedExternalId 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.
countinteger
The number of users to return
startIndexinteger
An integer index that determines the starting point of the sorted result list
Response
of embed users
Example response
{
"Resources": [
{
"meta": {
"resourceType": "User"
}
}
]
}