get users informations
GET/v1/usersRequest
Query Params
sso_id
object
optional
cell
object
optional
Request samples
Responses
Default users list response(200)
Default users list response
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
users
array[object (user) {6}]
optional
id
integer
optional
uniqe identifier of any user
Example:
123
name
string | null
optional
Name of the user
Example:
Mohammad
family
string | null
optional
Family of the user
Example:
Mohammadian
image
string | null
optional
image of the user
Example:
example.jpg
sso_id
string
optional
uniqe id of OAuth2 SSO system
Example:
d90af07e-7d71-11ee-86c8-005056ad7d06
gender
enum<string> | enum<null>
optional
Gender of the user
Allowed values:
malefemale
Example:
male
Example
{
"users": [
{
"id": 123,
"name": "Mohammad",
"family": "Mohammadian",
"image": "example.jpg",
"sso_id": "d90af07e-7d71-11ee-86c8-005056ad7d06",
"gender": "male"
}
]
}Last modified: 7 months ago