v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Job Posting

jobPosting.list

Lists published job postings. By default, only published job postings are returned.

Set includeUnpublishedJobPostings to true to also include unpublished (draft) job postings.

Important: By default, this endpoint includes all listed and unlisted job postings. Unlisted job postings should not be displayed publicly. If you are using the API to publicly expose job postings, set the listedOnly parameter to true when calling this API so that you only fetch listed job postings that can be displayed publicly.

Requires the jobsRead permission.

post/jobPosting.list

Request body

locationstring nullable

Filter by location name (case sensitive)

departmentstring nullable

Filter by department name (case sensitive)

listedOnlyboolean nullable

If true, filter out unlisted job postings.

includeUnpublishedJobPostingsboolean nullable

If true, include unpublished (draft) job postings in addition to published job postings.

jobBoardIdstring uuid nullable

If provided, only returns the job postings on the specified job board. If omitted, this API will return the job postings on the primary external job board.

Example request

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

Response

Responses from the jobPosting.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "title": "Software Engineer",
      "jobId": "8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d",
      "departmentName": "Engineering",
      "teamName": "Product Engineering",
      "locationName": "San Francisco",
      "locationIds": {
        "primaryLocationId": "7bb8f10f-12d0-4d26-8d08-0f432a67b123",
        "secondaryLocationIds": []
      },
      "workplaceType": "OnSite",
      "employmentType": "FullTime",
      "isListed": true,
      "publishedDate": "2024-01-15",
      "applicationDeadline": null,
      "externalLink": "https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "applyLink": "https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "compensationTierSummary": "$100K - $120K",
      "shouldDisplayCompensationOnJobBoard": true,
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}