Skip to main content
GET
/
flow
/
{flowName}
/
task
Generate example
curl --request GET \
  --url https://apiweb.mile.app/api/v3/flow/{flowName}/task \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "Success.",
  "data": {
    "flowName": "Pickup",
    "flowFields": [
      {
        "field": "hubId",
        "type": "string",
        "required": true,
        "description": "The identifier for the hub that generated by system.\r\nUse GET /hubs API to get the list of Hub IDs.",
        "example": "63e0842e1d09947148301a92",
        "format": null
      },
      {
        "field": "flow",
        "type": "string",
        "required": true,
        "description": "The unique name of organization's flow.\r\nUse Flow /flows API to get the list of flow names.",
        "example": "Pickup",
        "format": null
      },
      {
        "field": "startTime",
        "type": "string",
        "format": null,
        "required": true,
        "description": "Start datetime of task to active.",
        "example": "2023-05-15T04:26:00.000+00:00"
      },
      {
        "field": "endTime",
        "type": "string",
        "format": null,
        "required": true,
        "description": "End datetime of task to active.",
        "example": "2023-05-16T04:26:00.000+00:00"
      },
      {
        "field": "requesterName",
        "type": "string",
        "required": false,
        "description": "This field's type & value is according to Flow's setting.",
        "example": "Loid Forger",
        "format": null
      },
      {
        "field": "requesterPhone",
        "type": "string",
        "required": false,
        "description": "This field's type & value is according to Flow's setting.",
        "example": "081163137712",
        "format": null
      },
      {
        "field": "address",
        "type": "string",
        "required": false,
        "description": "This field's type & value is according to Flow's setting.",
        "example": "92553 Walsh Crest Apt. 213\nFerrymouth, OR 81988-7765",
        "format": null
      },
      {
        "field": "pickupPoint",
        "type": "string",
        "required": false,
        "description": "This field's type & value is according to Flow's setting.",
        "example": "68.978483,-67.186351",
        "format": null
      },
      {
        "field": "packageType",
        "type": "string",
        "required": false,
        "description": "This field's type & value is according to Flow's setting.",
        "example": "Document",
        "format": [
          "Food",
          "Clothes",
          "Document",
          "Medicine",
          "Books",
          "Others"
        ]
      }
    ],
    "bodyRequest": {
      "hubId": "63e0842e1d09947148301a92",
      "flow": "Pickup",
      "startTime": "2023-05-15T04:26:00.000+00:00",
      "endTime": "2023-05-16T04:26:00.000+00:00",
      "requesterName": "Loid Forger",
      "requesterPhone": "081163137712",
      "address": "92553 Walsh Crest Apt. 213\nFerrymouth, OR 81988-7765",
      "pickupPoint": "68.978483,-67.186351",
      "packageType": "Document"
    }
  }
}

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

flowName
string
required

The unique name of organization's flow. Use Flow /flows API to get the list of flow names. Example: Pickup

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

data
object

Detail of object genarate flows.