Skip to content
Kindgi

List users in the tenant

GET
/v1/identity/users
curl --request GET \
  --url 'https://example.com/v1/identity/users?limit=25' \
  --header 'Authorization: Bearer <token>'

Cursor-paginated list of tenant users (sort order is binding-defined). Optional ?query= is a prefix match on displayName — the natural filter shape for a “search users” surface. primaryEmail may be redacted per tenant policy.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Opaque cursor from a prior response. Absent → first page.

query
string

Prefix match on displayName.

Responses

Section titled “Responses”

200

Section titled “200”

Page of users.

Media typeapplication/json
object
data
required
Array<object>

Tenant-scoped user record (admin plane). primaryEmail may be redacted on the wire based on tenant policy (the routes treat it as opaque). metadata is free-form JSON — deployments carry IdP claims / provisioning source / roles here.

object
userId
required
string
tenantId
required
string format: uuid
primaryEmail
string
displayName
string
createdAt
required
string format: date-time
lastActiveAt
string format: date-time
metadata
object
key
additional properties
any
hasMore
required
boolean
nextCursor
string
Examplegenerated
{
  "data": [
    {
      "userId": "example",
      "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "primaryEmail": "example",
      "displayName": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "lastActiveAt": "2026-04-15T12:00:00Z",
      "metadata": {}
    }
  ],
  "hasMore": true,
  "nextCursor": "example"
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}