List

Get Clients

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

This endpoint allows you to get all existing clients. This route is only for Master Users.

Query Parameters

Name	Type	Description
search	string	Search field for key and name columns
sortBy	string	Pagination column order (default name)
order	string	Pagination order (default asc)
page	integer	Page number (default 1)
limit	integer	Pagination limit (default 10)

Headers

Name	Type	Description
Authorization	string	Authentication user token

200

{
  "data": [
    {
      "key": "master",
      "name": "Master",
      "flows": [
        "5f06dd3c198040265c1fc733",
        "5f06f2d9c4a01e11c075a6c9"
      ],
      "pusher": {
        "appId": "",
        "key": "",
        "secret": "",
        "privateChannels": true
      },
      "twilio": null,
      "biometrid": null,
      "settingsId": "5f06dd350d2a954da80c098e",
      "isMaster": true,
      "active": true,
      "created_at": "2020-07-09T09:02:46.109Z",
      "updated_at": "2020-07-09T10:36:03.859Z",
      "id": "5f06dd360d2a954da80c098f",
      "settings": {
        "name": "Default",
        "date": {
          "workingHours": [],
          "holidays": []
        },
        "process": {
          "actions": {
            "delete": true,
            "reject": true,
            "approve": true,
            "correct": true,
            "schedule": true,
            "conference": true
          },
          "modules": {
            "search": true,
            "queue": true,
            "filters": true
          },
          "columns": [
            {
              "type": "string",
              "title": "Process",
              "field": "_id"
            },
            {
              "type": "string",
              "title": "Status",
              "field": "status"
            },
            {
              "type": "date",
              "title": "Created",
              "field": "created_at"
            }
          ]
        },
        "clientId": "",
        "forAllClients": true,
        "active": true,
        "created_at": "2020-07-09T09:02:45.895Z",
        "updated_at": "2020-07-09T09:02:45.896Z",
        "id": "5f06dd350d2a954da80c098e"
      }
    }
  ],
  "meta": {
    "message": "Success.",
    "pagination": {
      "total": 1,
      "limit": 10,
      "page": 1,
      "lastPage": 1,
      "sortBy": "id",
      "order": "asc"
    }
  },
  "status": true
}

401 Wrong or empty Authorization token.

{
  "data": {},
  "meta": {
    "message": "Invalid JWT signature",
    "code": "E_INVALID_JWT_TOKEN"
  },
  "status": false
}