Skip to main content

Get users

Foreword

HTTP method : GET

v2/users?page=2&size=10

ParameterDescriptionFormat
pageResults pageNumber
sizeNumber of elements per pageNumber

Parameter page is mandatory. Parameter size is optional. It is the number of items returned per page. Default size = 50 and max size = 100. This route displays the users opened and suspended of the organization.

Response

200 OK

count is the total number of elements. Sorted alphabetically by email address.

{
"metadata": {
"requestId": "",
"count": 0,
"page": 0,
"size": 0
},
"data": {
"users": [
{
"id": "string",
"lastName": "string",
"firstName": "string",
"email": "string",
"suspensionStartDate": "ISO string"
},
{
"id": "string",
"lastName": "string",
"firstName": "string",
"email": "string",
"suspensionStartDate": "ISO string"
}
]
}
}