---
title: "Get VMS Jobs by VMS ID"
method: GET
path: "/v1/job/vms-jobs/{vmsId}"
tags: ["Jobs"]
---

# Get VMS Jobs by VMS ID

`GET /v1/job/vms-jobs/{vmsId}`

## Request

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

Returns details about the VMS jobs associated with the specified VMS ID.

## Path parameters

- `vmsId` string, nullable, required

## Headers

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

## Response `200`

An array of VMS Jobs for the requested VMS ID.

- VmsJobBasicDto[]
  - `vmsJobId` integer: The VMS job identifier.
  - `vmsId` string, nullable: The VMS identifier (external system identifier).
  - `jobId` integer, nullable: The Bold job identifier, if the VMS job has been actioned.
  - `vmsCompany` string, nullable: The VMS company name.
  - `title` string, nullable: The job title.
  - `status` string, nullable: The job status name.
  - `positions` integer: The number of positions available.
  - `startDate` string, date-time: The job start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.
  - `endDate` string, date-time: The job end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.
  - `vmsNotes` string, nullable: Notes related to the VMS job.
  - `vmsName` string, nullable: The VMS name (e.g., "SimpleVMS", "JobRobotix").
  - `vendorId` integer, nullable: The vendor identifier.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Access Denied
- `404`: Not Found
- `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

---

[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)