Show Steps

Get Flow Steps

GET https://biometrid.com/api/flows/:id/steps

This endpoint allows you to get a flow steps information by ID.

Path Parameters

Name	Type	Description
id	string	ID of the flow to get

Headers

Name	Type	Description
Accept-Language	string	en (default), pt
Authorization	string	Authentication account token

200

{
  "data": [
    {
      "name": {String},
      "description": {String},
      "accountId": {String},
      "active": {Boolean},
      "actions": [
        {
          "type": "form", // other types available
          "fields": [
            {
              "type": "checkbox", // other types available
              "alias": {String},
              "label": {String},
              "options": [
                {
                  "value": {String},
                  "label": {String}
                },
              ],
              "rules": [
                {
                  "type": "required" // other rules available
                },
              ]
            },
          ]
        }
      ],
      "settings": {
        "wait": {Boolean}
      },
      "createdAt": {Date},
      "updatedAt": {Date},
      "id": {String}
    },
  ],
  "meta": {
    "message": "Success."
  },
  "status": true
}

404

{
  "data": {},
  "meta": {
    "message": "Flow not found",
    "code": "BIOFSGB001"
  },
  "status": false
}