https://api.katapult.io/core/v1/tasks/task
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
task_not_found
|
No task was found matching any of the criteria provided in the arguments |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
task[id]
string
query
task
object
id
string
name
string
status
string
created_at
integer
started_at
integer
finished_at
integer
progress
integer
{
"task": {
"id": "string",
"name": "string",
"status": "pending",
"created_at": 0,
"started_at": 0,
"finished_at": 0,
"progress": 0
}
}Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Left blank, a parameter is omitted from the request.