Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude

Get Job Definition Api V1 Workstreams Jobs Job Id Get

get/api/v1/workstreams/jobs/{job_id}

Get job definition

Get a job definition by ID or permakey.

Path parameters

job_idrequired
path
β€”

Responses

200Successful Response
FieldTypeDescription
idrequiredstring (uuid)β€”
permakeystring | nullStable human-readable key for the batch/fan-out deep-link URL /workstreams/{ws}/cycles/{permakey}/… (#173). Null on legacy rows.
namerequiredstringβ€”
descriptionstring | nullβ€”
domainrequiredstringβ€”
goal_templaterequiredstringβ€”
toolsrequiredstring[]β€”
deliverablesrequiredobject[]β€”
item shape
Empty object.
max_turnsrequiredintegerβ€”
max_cost_usdrequirednumberβ€”
max_duration_minutesrequiredintegerβ€”
target_selectorrequiredobjectβ€”
show nested
Empty object.
per_client_overridesrequiredobjectβ€”
show nested
Empty object.
default_contextrequiredobjectβ€”
show nested
Empty object.
source_tracingrequiredbooleanβ€”
human_checkpointsrequiredstring[]β€”
schedulestring | nullβ€”
schedule_timezonerequiredstringβ€”
is_enabledrequiredbooleanβ€”
next_run_atany | nullβ€”
last_run_atany | nullβ€”
statusrequiredstringβ€”
created_byrequiredstringβ€”
created_atrequiredanyβ€”
updated_atrequiredanyβ€”
current_versioninteger | nullLatest version number in job_definition_version; null if no history yet.
422Validation Error
FieldTypeDescription
detailValidationError[]β€”
item shape
curl https://api.dev.arch.ie/api/v1/workstreams/jobs/<job_id> \
  -H "Authorization: Bearer sk_..."