ZITADEL Docs
APIsCore ResourcesV2User

Search Users

Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.

POST
/v2/users

Request Body

application/json

query?

list limitations and ordering

sortingColumn?string

the field the result is sorted

Value in"USER_FIELD_NAME_UNSPECIFIED" | "USER_FIELD_NAME_USER_NAME" | "USER_FIELD_NAME_FIRST_NAME" | "USER_FIELD_NAME_LAST_NAME" | "USER_FIELD_NAME_NICK_NAME" | "USER_FIELD_NAME_DISPLAY_NAME" | "USER_FIELD_NAME_EMAIL" | "USER_FIELD_NAME_STATE" | "USER_FIELD_NAME_TYPE" | "USER_FIELD_NAME_CREATION_DATE"
queries?array<|||||||||||||||||>

criteria the client is looking for

[key: string]?never

Response Body

application/json

curl -X POST "https://loading/v2/users" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "timestamp": "2023-01-15T01:30:15.01Z"
  },
  "sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "userId": "string",
      "details": {
        "sequence": 0,
        "changeDate": "2023-01-15T01:30:15.01Z",
        "resourceOwner": "string",
        "creationDate": "2023-01-15T01:30:15.01Z"
      },
      "state": "USER_STATE_UNSPECIFIED",
      "username": "string",
      "loginNames": [
        "string"
      ],
      "preferredLoginName": "string",
      "human": {
        "userId": "string",
        "state": "USER_STATE_UNSPECIFIED",
        "username": "string",
        "loginNames": [
          "string"
        ],
        "preferredLoginName": "string",
        "profile": {
          "givenName": "string",
          "familyName": "string",
          "nickName": "string",
          "displayName": "string",
          "preferredLanguage": "string",
          "gender": "GENDER_UNSPECIFIED",
          "avatarUrl": "string"
        },
        "email": {
          "email": "string",
          "isVerified": true
        },
        "phone": {
          "phone": "string",
          "isVerified": true
        },
        "passwordChangeRequired": true,
        "passwordChanged": "2023-01-15T01:30:15.01Z",
        "mfaInitSkipped": "2023-01-15T01:30:15.01Z"
      }
    }
  ]
}

Was this page helpful?

Search Personal Access Tokens

Search Personal Access Tokens: List all personal access tokens. By default all personal access tokens of the instance on which the caller has permission to read the owning users are returned. Make sure to include a limit and sor...

SendEmailCode

Explore the SendEmailCode operation in the ZITADEL API. Learn about request parameters, response schemas, and integration details for this endpoint.