Get Task

This endpoint returns information about a task with the given ID.

Request

taskId · string · required

ID of the related task.

Response

completedAt · int

CompletedAt is the time when the task is processed successfully. Unix timestamp with millisecond precision

deadline · int

Deadline is the deadline for the task. Unix timestamp with millisecond precision

error · string

Error is the error message from the last failure.

lastErrorAt · string

LastErrorAt is the time time of the last failure if any. Unix timestamp with millisecond precision

maxRetry · string · required

MaxRetry is the maximum number of times the task can be retried.

messageId · string · required

Id is the identifier of the the message for this task.

nextProcessAt · int

NextProcessAt is the time the task is scheduled to be processed, Unix timestamp with millisecond precision

retried · int · required

Retried is the number of times the task has retried so far.

state · string · required

The current state of this task

taskId · string · required

Id is the identifier of the task.

url · string · required

URL is the destination where we should send the message.

curl

curl -X GET \
  https://qstash.upstash.io/v1/tasks/:taskId \
  -H "Authorization: Bearer <token>"

200

{
    "completedAt": 1678900876543,
    "error": "Connection timeout",
    "lastErrorAt": 1678901800000,
    "maxRetry": 5,
    "messageId": "msg_123",
    "nextProcessAt": 1678902100000,
    "retried": 4,
    "state": "retrying",
    "taskId": "tsk_123",
    "url": "https://example.com"
}