Skip to content

Get the User's job

GET
/api/v1/jobs/{id}
curl --request GET \
--url https://example.com/api/v1/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Returns the User’s job. It requires a signed-in User with the data scope. It can return 401 if the session is missing or expired, 403 if access is denied and 404 if the requested item does not exist. Route: /api/v1/jobs/{id}. Inputs: id. Safe reads can use bounded retries.

id
required
string format: uuid
Media typeapplication/json
object
cancellation_requested
required
boolean
created_at
required
string
id
required
string
kind
required
string
label
required
string
last_error
string | null
progress_current
integer | null format: int64
progress_message
string | null
progress_total
integer | null format: int64
state
required
string
stoppable
required
boolean
updated_at
required
string
Examplegenerated
{
"cancellation_requested": true,
"created_at": "example",
"id": "example",
"kind": "example",
"label": "example",
"last_error": "example",
"progress_current": 1,
"progress_message": "example",
"progress_total": 1,
"state": "example",
"stoppable": true,
"updated_at": "example"
}