Zitadel Preview Docs

List users

GET
/users

Authorization

oauth2 user.read
AuthorizationBearer <token>

In: header

Scope: user.read

Query Parameters

limit?integer

Maximum number of items to return.

page_token?string

Token for fetching the next page of results. Obtain this value from next_page_token in the previous response. Omit to start from the beginning. Its format is opaque and may change between releases.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users"
{  "users": [    {      "id": "user_id_12345",      "schema": "string",      "attributes": {},      "metadata": {        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "status": "active",        "lifecycle_owner_team_id": "string"      }    }  ],  "next_page_token": "v1.dGhpcyBpcyBvcGFxdWU.SflKxwRJSMeKKF2QT4fw"}
{  "code": "string",  "message": "string",  "details": {}}
{  "code": "string",  "message": "string",  "details": {}}

{  "code": "auth.unauthorized",  "message": "The request lacks valid authentication credentials."}