Show

Get Client by ID

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

This endpoint allows you to get a client information by ID. This route is only for Master Users.

Path Parameters

Name	Type	Description
id	string	ID of the client to get

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",
    "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"
    },
    "id": "5f06dd360d2a954da80c098f"
  },
  "meta": {
    "message": "Success."
  },
  "status": true
}

404

{
  "data": {},
  "meta": {
    "message": "Client not found",
    "code": "4012"
  },
  "status": false
}

Get my Client

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

This endpoint allows you to get the user client information.

Headers

Name	Type	Description
Authorization	string	Authorization 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",
    "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"
    },
    "id": "5f06dd360d2a954da80c098f"
  },
  "meta": {
    "message": "Success."
  },
  "status": true
}