API Reference

Katapult Core API

Resources & Endpoints

Get Task

Returns details about a specific task.

GET
https://api.katapult.io/core/v1/tasks/{task}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

task Required

Task Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

task_not_found

No task was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    task: Task {
        id: String
        name: String
        status: TaskStatusEnum
        created_at: Unix Timestamp
        started_at: Unix Timestamp?
        finished_at: Unix Timestamp?
        progress: Integer
    }
}