GET
/
rest
/
tasks
curl --request GET \
  --url https://copilotz.com/rest/tasks \
  --header 'Authorization: Bearer <token>'
[
  {
    "extId": "This is an external ID if you want to match an external system.",
    "workflow": 1,
    "currentStep": 1,
    "status": "active",
    "name": "Task Name",
    "description": "This is the description you want to give for your task.",
    "context": {}
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
Successful response
​
workflow
integer
required

ID of the workflow this task belongs to.

Example:

1

​
currentStep
integer
required

ID of the current step in the workflow that this task is working on.

Example:

1

​
status
enum<string>
required

Current status of the task.

Available options:
active,
pending,
failed
Example:

"active"

​
name
string
required

Name assigned to the task.

Example:

"Task Name"

​
description
string
required

Detailed description of the task.

Example:

"This is the description you want to give for your task."

​
extId
string

External ID for matching with external systems.

Example:

"This is an external ID if you want to match an external system."

​
context
object

Arbitrary data stored for future references.

Example:
{}