Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Jobs

Get a Posted Job

Returns details about the specified job post.

get/v1/postedJobs/{jobPostingId}

Path parameters

jobPostingIdstring required

The identifier for the job post that is being retrieved.

Query parameters

includeJobDescHtmlstring

An indication of whether to include the HTML-formatted job description in the response.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

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 requested job post.

jobPostingIDinteger

The identifier for the job post.

jobIdinteger

The identifier for the job.

titlestring

The job title on the job board.

descriptionstring

The job post description on the job board.

postedDateTimestring date-time

The date the job was posted. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

citystring

The city where the job is located.

statestring

The state or province where the job is located.

postalCodestring

The postal code for the job location.

countrystring

The country where the job is located.

jobBoardUrlstring

The URL for the external job post.

Example response

{
  "jobPostingID": 43566,
  "jobId": 234,
  "title": "Senior Clerical Officer",
  "description": "The role is responsible for clerical activities",
  "postedDateTime": "2024-12-01T14:30:00.546Z",
  "city": "Dayton",
  "state": "Ohio",
  "postalCode": "55149",
  "country": "United States Of America",
  "jobBoardUrl": "https://jobs.example.com/postings/43566",
  "jobBoardArr": [
    {
      "externalJobBoardName": "Indeed"
    }
  ]
}