Skip to main content
GET
/
flow
/
{flowId}
Read flow by ID
curl --request GET \
  --url https://apiweb.mile.app/api/v3/flow/{flowId} \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "Success",
  "flow": {
    "_id": "6352736c628401059b37a1d1",
    "name": "Delivery",
    "pages": [
      {
        "id": "page0",
        "enabled": true,
        "components": [
          {
            "component": "input",
            "id": "title",
            "inputType": "string",
            "default": null,
            "title": "Title",
            "isRequired": true,
            "visible": true,
            "showAs": "title"
          },
          {
            "component": "input",
            "id": "content",
            "inputType": "string",
            "default": null,
            "title": "Content",
            "isRequired": true,
            "visible": true,
            "showAs": "content"
          },
          {
            "component": "input",
            "id": "receiverName",
            "inputType": "string",
            "default": "Admin Hub",
            "title": "ReceiverName",
            "isRequired": false,
            "visible": true
          },
          {
            "component": "input",
            "id": "qty",
            "inputType": "number",
            "default": "1",
            "title": "Quantity",
            "isRequired": false,
            "visible": true
          },
          {
            "component": "input",
            "id": "deliveryTime",
            "inputType": "string",
            "default": null,
            "title": "Delivery Time",
            "isRequired": false,
            "visible": true
          },
          {
            "component": "select",
            "id": "label",
            "default": null,
            "options": [
              "CGR",
              "HDR",
              "HJK",
              "NYT"
            ],
            "min": 0,
            "max": 2,
            "title": "Label",
            "visible": true
          },
          {
            "component": "select",
            "id": "deliveryStatus",
            "options": [
              "success",
              "failed"
            ],
            "default": "success",
            "title": "Delivery Status",
            "min": 0,
            "max": 1,
            "visible": true
          }
        ]
      },
      {
        "id": "page1",
        "components": [
          {
            "component": "input",
            "id": "receiver",
            "inputType": "string",
            "default": null,
            "title": "Receiver",
            "isRequired": false,
            "visible": true
          },
          {
            "component": "input",
            "id": "codAmount",
            "inputType": "number",
            "default": "1",
            "title": "codAmount",
            "isRequired": false,
            "visible": true
          },
          {
            "component": "select",
            "id": "statusDelivery",
            "default": null,
            "options": [
              "Success",
              "Failed"
            ],
            "min": 0,
            "max": 1,
            "title": "Status Delivery",
            "visible": true
          }
        ]
      }
    ],
    "configurations": [
      {
        "id": "startTime",
        "adjustment": 0
      },
      {
        "id": "endTime",
        "adjustment": 24
      }
    ],
    "isDefault": true,
    "version": 2,
    "orderIndex": 1,
    "createdBy": "jhon@example.com",
    "updatedBy": "jhon@example.com",
    "createdTime": "2021-12-14T04:30:45.538000Z",
    "updatedTime": "2021-12-14T05:10:01.801000Z"
  }
}

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

flowId
string
required

Unique identifier for the flow that generated by system. Example: 6352736c628401059b37a1d1

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

flow
object

Detail of object flow.