Search Users
Search for users. By default, the first 100 users of your instance that you have permission to read are returned (the default and the maximum limit of 1000 can be configured). Make sure to include a limit and sorting for pagination.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/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.
