Skip to main content
GET
/
api
/
svc
/
v1
/
users
List users
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "jqfwg345gi25n5ju2yz5iz6m",
      "email": "<string>",
      "tenantName": "<string>",
      "metadata": {
        "sub": "<string>",
        "imageURL": "<string>",
        "pictureDownloadPath": "<string>",
        "displayName": "<string>",
        "userObject": {},
        "inviteAccepted": true,
        "registeredInIdp": true,
        "preference": {},
        "groups": [
          "<string>"
        ],
        "ssoName": "<string>",
        "scimUserObject": {},
        "createdByScim": true
      },
      "active": true,
      "isEditable": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "roles": [
        "<string>"
      ],
      "rolesWithResource": [
        {
          "roleId": "<string>",
          "resourceId": "<string>",
          "roleName": "<string>"
        }
      ],
      "accounts": [
        {
          "accountId": "<string>",
          "name": "<string>"
        }
      ],
      "lastAccessedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer | null
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
query
string | null

Filter users by email substring match.

Example:

"john@example.com"

​
showInvalidUsers
boolean | null
default:false

When true, includes deactivated users in the response.

Response

200 - application/json

Paginated list of users the caller has access to.

​
data
User · object[]
required

Array of users matching the query.

​
pagination
Pagination · object
required

Pagination metadata.