CLclevergy
Users

Get users

Returns a paginated list of users filtered by a given criteria. If no filter parameter is included (nif, email), all the tenant users shall be returned.

get/users

Request

  • Base URL
    https://connect.clever.gy
  • Auth
    API key in header clevergy-api-key

Query parameters

pageinteger

Number of the page starting at 1

sizeinteger

Size of the page

sort'id' | 'name' | 'surname' | 'email' | 'nif'

Field to order by.

direction'ASC' | 'DESC'

Direction of the order.

nifstring

Filter by nif

emailstring

Filter by email

Response

paginated list of users

sizeinteger required

Number of elements in the page requested

pageinteger required

Number of the page requested

totalPagesinteger required

Number of total pages

totalElementsinteger required

Number of total elements in the list

Example response

{
  "elements": [
    {
      "id": "U4NW5zdmstUtRZW5Oi3S2CR5l0U2",
      "name": "Pedro",
      "surname": "García",
      "email": "pedro.garcia@mail.com",
      "nif": "00000000T"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.