Skip to content
Authrim

Get an admin job.

GET
/api/admin/jobs/{id}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/jobs/example \
  --header 'Authorization: Bearer <token>'

Returns one tenant admin job by id, including status, progress, retry metadata, timing fields, and parsed job parameters when available.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Job status response.

Media type application/json
object
job_id
required
string
type
required
string
status
required
string
Allowed values: pending processing completed failed partial_failure
progress
required
object | null
created_by
required
string
created_at
required
string | null format: date-time
updated_at
required
string | null format: date-time
started_at
required
string | null format: date-time
completed_at
required
string | null format: date-time
estimated_completion
required
string | null format: date-time
next_run_at
required
string | null format: date-time
attempts
required
integer
max_attempts
required
integer
dead_lettered_at
required
string | null format: date-time
error_code
string
error_message
string
parameters
object
key
additional properties
key
additional properties
Example 
{
  "status": "pending"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}