Dedicated Partner Job Feeds
Ashby can provision a dedicated job posting feed for a partner interested in ingesting job postings. Once the integration is live, Ashby customers can opt-in to sharing their jobs with the partner's service by enabling the partner's integration in the Admin section of the Ashby app. After this is done, all of their published job postings will be published to the feed for the partner to ingest.
The schema of the feed is fixed, but the format can be in JSON or XML formats. The data provided in JSON and XML feeds is identical between the feeds and is updated hourly.
Interested?
If you are interested in obtaining a dedicated feed, contact [email protected]
Job Posting Schema
Job postings are provided in a flat list
| Parameter | Type | Description | Required? |
|---|---|---|---|
id | String | A UUID of the job posting. | Yes |
organizationId | String | A UUID of the organization. | Yes |
organizationName | String | The name of the organization in Ashby. | Yes |
title | String | The title of the job posting. | Yes |
departmentName | String | The department of the job posting. | Yes |
teamName | String | The team of the job posting. | No |
descriptionPlain | String | The job posting description in plain text . | Yes |
descriptionHtml | String | HTML block of the job posting description. | Yes |
employmentType | String | The type of employment. Will be one of the following: FullTime, PartTime, Intern, Contract, or Temporary. | Yes |
externalLink | String | A link to the application form. | Yes |
updatedAt | String | The UTC date time in GMT of when this job post was last updated. | Yes |
publishedAt | String | The UTC date time in GMT of when this job post was published. | Yes |
locations | Array | An array of locations that this posting is assigned to (see below for location schema). | Yes |
compensationTiers | Array | An array of compensation tiers (see below for compensation schema). | No |
Location Schema
Location follows Place as defined by schema.org. In particular, the postalAddress schema.
| Parameter | Type | Description | Required? |
|---|---|---|---|
locationName | String | The name of the location. | Yes |
address | Object | The address of the location (see below for address schema). | No |
isRemote | Boolean | Indicates if this job posting is eligible for remote work. | Yes |
isPrimaryLocation | Boolean | Indicates in this is the primary location if there are multiple locations for this posting. There can only be one primary location per posting. | Yes |
Address Schema
Address follows the postalAddress as defined at schema.org.
| Parameter | Type | Description | Required? |
|---|---|---|---|
addressCountry | String | The country of the location. This is NOT guaranteed to be a county code. | No |
addressRegion | String | The region (state, province, etc) of the location. | No |
addressLocality | String | The locality (city, town, village, etc.) of the location. | No |
postalCode | String | The postal code of the location. | No |
postOfficeBoxNumber | String | The PO box number of the location. | No |
streetAddress | String | The street address of the location. | No |
Compensation Schema
Ashby provides a rich set of compensation data comprising of compensationTiers. Each tier consists of a title, an array of components and an additionalInformation field.
Compensation Tier Schema
| Parameter | Type | Description | Required? |
|---|---|---|---|
title | String | The title of the tier. | Yes |
components | Array | The components that make up this compensation tier. They detail salary, commission, equity, and bonus structure. | Yes |
additionalInformation | String | Any additional information that may be necessary to understand the tier. | No |
Compensation Component Schema
Each tier will have between 1 and 4 components that detail salary, commission, equity, and bonus structure.
| Parameter | Type | Description | Required? |
|---|---|---|---|
compensationType | String | The type of compensation. Possible values are Salary, EquityPercentage, EquityCashValue, Bonus, and Commission | Yes |
summary | String | A generated summary of the component. Example: "Base Salary $70K – $100K" | No |
Interval | String | The period on which this compensation is given. Possible values are NONE, 1 TIME, 1 HOUR, 1 DAY, 1 WEEK, 2 WEEK, 0.5 MONTH, 1 MONTH, 2 MONTH, 3 MONTH, 6 MONTH, and 1 YEAR | Yes |
minValue | Number | The minimum of this compensation range. | Yes |
maxValue | Number | The maximum of this compensation range. | Yes |
currencyCode | String | The currency code this compensation component is paid in. Applied to all types except EquityPercentage, | No |
Meta Schema
Ashby also provides a meta object that contains additional information and context. At the moment, the only provided metadata is for organizations as outlined below.
| Parameter | Type | Description | Required? |
|---|---|---|---|
id | String | A UUID of the organization (matches organizationId in the job posting entry). | Yes |
name | String | The name of the organization in Ashby (matches organizationName in job posting entry) | Yes |
link | String | A link to the organization's website. | Yes |
jobBoardLink | String | A link to the Ashby job board of the organization. | Yes |
Updated about 1 year ago