Skip to main content
Get task status
curl --request GET \
  --url https://{tenantId}.api.nestmed.com/api/v1/tasks/{taskId} \
  --header 'Authorization: Bearer <token>'
{
  "taskId": "<string>",
  "status": "queued",
  "progressPercent": 50,
  "message": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "result": {
    "type": "<string>",
    "url": "<string>"
  },
  "error": {}
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
taskId
string
required

Response

Task status.

​
taskId
string
​
status
enum<string>
Available options:
queued,
inProgress,
completed,
failed,
canceled
​
progressPercent
integer

The completion percentage of the task.

Required range: 0 <= x <= 100
​
message
string | null

A human-readable status message.

​
createdAt
string<date-time>
​
completedAt
string<date-time> | null
​
result
object
​
error
object