Get User Phone (Human)
GET/users/:userId/phone
Get the phone number and the verification state of the number. The phone number is only for informational purposes and to send messages, not for Authentication (2FA).
Deprecated: please use user service v2 GetUserByID
Request​
Path Parameters
Header Parameters
The default is always the organization of the requesting user. If you like to get a user from another organization include the header. Make sure the requesting user has permission in the requested organization.
Responses​
- 200
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
phone
object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
{
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:47.267Z",
"changeDate": "2024-12-06T11:34:47.267Z",
"resourceOwner": "69629023906488334"
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
}
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
phone
object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
{
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:47.267Z",
"changeDate": "2024-12-06T11:34:47.267Z",
"resourceOwner": "69629023906488334"
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
}
}
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
phone
object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
{
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:47.268Z",
"changeDate": "2024-12-06T11:34:47.268Z",
"resourceOwner": "69629023906488334"
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}