AVavionte
Companies

Get Company Jobs

Returns a paginated, abbreviated list of jobs for the specified company.

get/v1/company/{companyId}/jobs

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/company/{companyId}/jobs
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

companyIdstring required

The identifier for the company whose jobs are being retrieved.

Query parameters

includeAllStatusesboolean

An indication of whether jobs of every status are included in the response. When true, jobs of every status are returned. When false (default), only open jobs are returned. Ignored when status is provided.

statusstring

Filters the results to jobs with the specified status. Must be a status recognized by the tenant. Takes precedence over includeAllStatuses.

countinteger

The number of jobs to return. Must be between 1 and 500. Defaults to 50.

startinteger

The zero-based offset into the result set. Defaults to 0.

sortstring

The Job Summary field to sort by, optionally prefixed with - for descending order (for example, -createdDate). Defaults to createdDate descending. Valid fields: jobId, jobTitle, status, openings, filled, companyId, companyName, officeId, officeName, createdDate, lastUpdatedDate.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The paginated list of jobs for the specified company.

totalRecordsinteger

The total number of jobs matching the filter, across all pages.

countinteger

The number of jobs requested per page.

startinteger

The zero-based offset into the result set for the current page.

Example response

{
  "jobs": [
    {
      "jobId": 188499,
      "jobTitle": "Warehouse Worker",
      "status": "Open",
      "openings": 5,
      "filled": 3,
      "companyId": 17845,
      "companyName": "Acme Corporation",
      "officeId": 15377,
      "officeName": "Minneapolis"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.