List

Get Flows

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

This endpoint allows you to get all existing flows.

Query Parameters

Name	Type	Description
search	string	Search field for name column
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

200

{
  "data": [
    {
      "name": "Flow 1",
      "stepsOrdered": [
        "5f06dd39a89fd30bd4671862",
        "5f06dd39a89fd30bd4671863",
        "5f06dd39a89fd30bd4671866",
        "5f06dd39a89fd30bd4671867",
        "5f06dd39a89fd30bd4671869",
        "5f06dd39a89fd30bd467186a",
        "5f06dd39a89fd30bd467186b",
        "5f06dd39a89fd30bd467186c",
        "5f06dd39a89fd30bd4671868"
      ],
      "settingsId": "5f06dd3c198040265c1fc732",
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T09:02:52.307Z",
      "updated_at": "2020-07-09T09:02:52.307Z",
      "id": "5f06dd3c198040265c1fc733"
    },
    {
      "name": "Flow 2",
      "stepsOrdered": [
        "5f06dd39a89fd30bd4671862"
      ],
      "settingsId": "5f06dd3c198040265c1fc732",
      "clientId": "5f06dd360d2a954da80c098f",
      "forAllClients": true,
      "active": true,
      "created_at": "2020-07-09T10:35:05.494Z",
      "updated_at": "2020-07-09T10:35:05.494Z",
      "id": "5f06f2d9c4a01e11c075a6c9"
    }
  ],
  "meta": {
    "message": "Success.",
    "pagination": {
      "total": 2,
      "limit": 10,
      "page": 1,
      "lastPage": 1,
      "sortBy": "id",
      "order": "asc"
    }
  },
  "status": true
}

401

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