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
All 'task[]' params are mutually exclusive, only one can be provided.
Responses
- 200
- 400
- 403
- 404
- 429
- 503
Returns details about a specific task
- application/json
- Schema
- Example (from schema)
Schema
task
object
required
Possible values: [pending
, running
, completed
, failed
]
{
"task": {
"id": "string",
"name": "string",
"status": "pending",
"created_at": 0,
"started_at": 0,
"finished_at": 0,
"progress": 0
}
}
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [missing_api_token
]
{
"code": "missing_api_token",
"description": "string",
"detail": {}
}
403 error response
- application/json
- Schema
- Example (from schema)
Schema
- UnauthorizedNetworkForAPITokenSchema
- InvalidAPITokenSchema
- InvalidCapabilitiesTokenSchema
- ScopeNotGrantedErrorSchema
oneOf
Network is not allowed to access the API with this API token
Possible values: [unauthorized_network_for_api_token
]
detail
object
The IP address the request was received from
The API token provided was not valid (it may not exist or have expired)
Possible values: [invalid_api_token
]
detail
object
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)
Possible values: [invalid_capabilities_token
]
The scope required for this endpoint has not been granted to the authenticating identity
Possible values: [scope_not_granted
]
detail
ScopeNotGrantedError
{}
No task was found matching any of the criteria provided in the arguments
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [task_not_found
]
{
"code": "task_not_found",
"description": "string",
"detail": {}
}
You have reached the rate limit for this type of request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [rate_limit_reached
]
detail
object
The total number of requests per minute that are permitted
{
"code": "rate_limit_reached",
"description": "string",
"detail": {
"total_permitted": 0
}
}
The service is currently unavailable, please try again later
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [service_unavailable
]
{
"code": "service_unavailable",
"description": "string",
"detail": {}
}