Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Jobs

Get Posted Jobs

Returns a list of posted jobs based on the search criteria posted in the request.

post/v1/postedJobs

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.

Request body

jobIdinteger

The identifier for the job, if searching for a specific job.

keywordsstring

The keywords to search for in the posted job title and description.

citystring

The city to include in the job search.

statestring

The state or province to include in the job search.

postalCodestring

The ZIP/postal code to include in the job search. It is required if radius is specified.

radiusinteger

The radius in miles for the job search, based on the postal code.

pageinteger

The page number to return in the paged results. Page 0 is the first page of results.

resultsPerPageinteger

The number of jobs to return per page of results.

Example request

{
  "jobId": 12345,
  "keywords": "Warehouse",
  "city": "Los Angeles",
  "state": "CA",
  "postalCode": "90001",
  "radius": 25,
  "resultsPerPage": 10
}

Response

A list of posted jobs.

totalJobsinteger

The total number of posted jobs returned in the page of results.

Example response

{
  "totalJobs": 10,
  "jobs": [
    {
      "jobId": 123456,
      "workSiteAddress": {
        "addressId": 123456,
        "jobId": 987654,
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "Los Angeles",
        "state": "CA",
        "postalCode": "90001",
        "country": "United States of America"
      },
      "employmentType": "Contract",
      "hourlyMinimum": 15,
      "hourlyMaximum": 25,
      "salaryMinimum": 50000,
      "salaryMaximum": 75000,
      "jobPostingID": 987654,
      "customJobDetails": [
        {
          "id": 12345,
          "jobId": 67890,
          "name": "Dress Code",
          "value": "Business Casual",
          "additionalValue": "No jeans",
          "type": "text",
          "isActive": true,
          "customJobDetailId": 54321
        }
      ],
      "title": "Warehouse Associate",
      "jobBoardName": "Indeed",
      "description": "Responsible for picking, packing, and shipping orders.",
      "requireResumeForWebApplicants": true
    }
  ]
}