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": "<string>",
      "email": "<string>",
      "tenantName": "<string>",
      "metadata": {
        "sub": "<string>",
        "imageURL": "<string>",
        "displayName": "<string>",
        "userObject": {},
        "inviteAccepted": true,
        "registeredInIdp": true,
        "preference": {},
        "groups": [
          "<string>"
        ],
        "tenantRoleManagedBy": "manual",
        "ssoName": "<string>"
      },
      "roles": [
        "<string>"
      ],
      "rolesWithResource": [
        {
          "roleId": "<string>",
          "resourceType": "role",
          "resourceId": "<string>"
        }
      ],
      "active": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

Authorization
string
header
required

Query Parameters

limit
integer
default:100
Required range: 1 <= x <= 1000
Example:
offset
integer
default:0
Required range: x >= 0
Example:
query
string
showInvalidUsers
boolean
includeVirtualAccounts
string

Response

200 - application/json
data
User · object[]
required
pagination
object
required