Skip to main content

Get Task

GET 

/tasks/task

Returns details about a specific task

Scopes

  • tasks
  • tasks:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

    task[id] string

    All 'task[]' params are mutually exclusive, only one can be provided.

Responses

Returns details about a specific task

Schema

    task

    object

    required

    id string
    name string
    status TaskStatusEnum (string)

    Possible values: [pending, running, completed, failed]

    created_at integer
    started_at integernullable
    finished_at integernullable
    progress integer
Loading...