---
title: "Get Job Status Definition by Name"
method: GET
path: "/v1/job-status/{name}"
tags: ["Jobs"]
---

# Get Job Status Definition by Name

`GET /v1/job-status/{name}`

## Request

- Base URL: `https://api.avionte.com/front-office`
- URL: `https://api.avionte.com/front-office/v1/job-status/{name}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns a job status by name that can be assigned to a job.

## Path parameters

- `name` string, required

## Headers

- `RequestId` string, uuid: Unique request identifier in UUID format used to correlate request data to log entries and events.
- `FrontOfficeTenantId` integer
- `Tenant` string

## Response `200`

The job status definition.

- JobStatusData
  - `id` integer: The identifier for the job status.
  - `item` string: The job status name.
  - `type` string: The type of job status. Values are "open" or "closed". Open and closed job statuses are grouped together in BOLD.
  - `statusOrder` integer: Numerical order value for the job status in the list of statuses in BOLD.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Access Denied
- `404`: Not found
- `405`: Unsupported method
- `406`: Unsupported format(s) indicated by Accept header
- `415`: Unsupported format(s) indicated by the Content-Type header
- `429`: Too many requests
- `500`: An unexpected error occurred
- `502`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/avionte/apis/bold-front-office-api.md) - [All operations](https://skmtc.dev/avionte/apis/bold-front-office-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/bold-front-office-api/revisions/bd5996cbaa0f?raw)