v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB

Job Posting

jobPosting.info

Retrieve an individual job posting.

Set includeUnpublishedJobPostings to true when fetching an unpublished (draft) job posting. This flag is required for draft postings; published postings can be fetched without it.

Result fields:

linkedData - Object that can be used to populate "rich results" in search engines. See more info here.
applicationFormDefinition - See the guide on Creating a custom careers page.

Requires the jobsRead permission.

post/jobPosting.info

Request body

jobPostingIdstring uuid required

The id of the job posting to return

jobBoardIdstring uuid nullable

If provided, returns the job posting data for the specified job board. If omitted, defaults to an external job board.

includeUnpublishedJobPostingsboolean nullable

If true, allows retrieving unpublished (draft) job postings. Required when fetching a draft job posting.

expandstring[] nullable

Choose to expand the result and include additional data for related objects.

Example request

{
  "jobPostingId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "jobBoardId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the jobPosting.info endpoint

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "title": "Software Engineer",
    "descriptionPlain": "This role will build and maintain customer-facing software.",
    "descriptionHtml": "<p>This role will build and maintain customer-facing software.</p>",
    "descriptionSocial": null,
    "descriptionParts": {
      "descriptionOpening": null,
      "descriptionBody": {
        "html": "<p>This role will build and maintain customer-facing software.</p>",
        "plain": "This role will build and maintain customer-facing software."
      },
      "descriptionClosing": null
    },
    "departmentName": "Engineering",
    "teamName": "Product Engineering",
    "teamNameHierarchy": [
      "Engineering",
      "Product Engineering"
    ],
    "jobId": "8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d",
    "locationName": "San Francisco",
    "locationAddress": "San Francisco, California, United States",
    "locationIds": {
      "primaryLocationId": "7bb8f10f-12d0-4d26-8d08-0f432a67b123",
      "secondaryLocationIds": []
    },
    "linkedData": {},
    "publishedDate": "2024-01-15",
    "applicationDeadline": null,
    "address": {
      "postalAddress": {
        "addressRegion": "California",
        "addressCountry": "United States",
        "addressLocality": "San Francisco"
      }
    },
    "isRemote": false,
    "workplaceType": "OnSite",
    "employmentType": "FullTime",
    "applicationFormDefinition": {},
    "surveyFormDefinitions": [],
    "isListed": true,
    "suppressDescriptionOpening": false,
    "suppressDescriptionClosing": false,
    "externalLink": "https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "applyLink": "https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "compensation": {
      "compensationTierSummary": "$100K - $120K",
      "summaryComponents": [
        {
          "summary": "$100K - $120K",
          "compensationType": "Salary",
          "interval": "1 YEAR",
          "currencyCode": "USD",
          "minValue": 100000,
          "maxValue": 120000
        }
      ],
      "compensationTiers": [
        {
          "id": "7acaf4b2-fbd2-47f9-8d09-222a3a469da1",
          "tierSummary": "$100K - $120K",
          "title": null,
          "additionalInformation": null,
          "components": [
            {
              "id": "e58d5b1e-6fc7-4df4-a418-e4f746235db7",
              "summary": "$100K - $120K",
              "compensationType": "Salary",
              "interval": "1 YEAR",
              "currencyCode": "USD",
              "minValue": 100000,
              "maxValue": 120000
            }
          ]
        }
      ],
      "shouldDisplayCompensation": true
    },
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "applicationLimitCalloutHtml": null
  }
}