latestOpenAPI 3.0.02026-08-1022826.0 KB
0b4aed700fc4
Users Read
Get your company's users
Returns users filtered by the parameters you select.
get/v1/users
Query parameters
pageinteger
Page cursor for use in pagination
sizeinteger
Number of records returned per page
Response
Successful operation
Example response
{
"data": [
{
"id": "318b301e-8c7c-4ac2-bfe6-03e6d03a9fee",
"userName": "john.malkovich@company.com",
"name": {
"familyName": "John",
"givenName": "Malkovich"
},
"emails": [
{
"value": "john.malkovich@company.com",
"emailType": "WORK"
}
],
"birthDate": "1990-12-01"
}
],
"page": {
"totalPages": 2,
"currentPage": 1,
"pageSize": 10,
"totalElements": 20
}
}