List

Get Users

GET https://biometridon.polygon.pt/api/users

This endpoint allows you to get all existing users.

Query Parameters

Name
Type
Description

search

string

Search field for firstName, lastName and email columns

sortBy

string

Pagination column order (default created_at)

order

string

Pagination order (default asc)

page

string

Page number (default 1)

limit

string

Pagination limit (default 10)

Headers

Name
Type
Description

Authorization

string

Authentication user token

{
  "data": [
    {
      "firstName": "Agent",
      "lastName": "Polygon",
      "email": "agent@polygon.pt",
      "clientId": "5f06dd360d2a954da80c098f",
      "roles": [
        "5f06dd360d2a954da80c0991"
      ],
      "isMaster": false,
      "active": true,
      "created_at": "2020-07-09T09:02:46.318Z",
      "updated_at": "2020-07-09T09:02:46.318Z",
      "id": "5f06dd360d2a954da80c0993",
      "name": "Agent Polygon"
    },
    {
      "firstName": "Master",
      "lastName": "Polygon",
      "email": "master@polygon.pt",
      "clientId": "5f06dd360d2a954da80c098f",
      "roles": [
        "5f06dd360d2a954da80c0990"
      ],
      "isMaster": true,
      "active": true,
      "created_at": "2020-07-09T09:02:46.215Z",
      "updated_at": "2020-07-09T09:02:46.215Z",
      "id": "5f06dd360d2a954da80c0992",
      "name": "Master Polygon"
    }
  ],
  "meta": {
    "message": "Success.",
    "pagination": {
      "total": 2,
      "limit": 10,
      "page": 1,
      "lastPage": 1,
      "sortBy": "id",
      "order": "asc"
    }
  },
  "status": true
}

Last updated

Was this helpful?