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": [
    {
      "id": "<string>",
      "userName": "<string>",
      "displayName": "<string>",
      "meta": {
        "resourceType": "User",
        "created": "2023-11-07T05:31:56Z",
        "lastModified": "2023-11-07T05:31:56Z"
      },
      "schemas": [
        "<string>"
      ]
    }
  ],
  "itemsPerPage": 123,
  "totalResults": 123,
  "startIndex": 123
}

Authorizations

​
Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Query Parameters

​
filter
string

Filter query (e.g., 'userName eq "user@example.com"')

​
count
integer
default:100

Number of results per page

​
startIndex
integer
default:1

Starting index for pagination

Response

List of users

​
Resources
object[]
​
itemsPerPage
integer
​
totalResults
integer
​
startIndex
integer