Getting started with the Careers Page API

https://api.employmenthero.com

Our Careers Page API is a RESTful-based API designed to help you integrate your Careers Page with your organisation's website.

By connecting your Employment Hero Careers Page to your organisation's website, any new job ads or edits to existing job ads will be available on your website.

How do I get an API Access Token?

To get started, you'll need to generate an API Access Token. You can do this by:

1/ Clicking 'General Settings' on the left-hand menu

2/ Selecting 'Recruitment Settings'

3/ Ensuring that you've enabled your Careers Page, you should now be able to see your API Access Token

ATS API

Get All Roles

curl "https://api.employmenthero.com/ats/api/v1/embedded/organisations/c12e0363-17b0-4f4b-99c7-09adea9f12ad/jobs" -H "X_ATS_TOKEN: a9207tx3NBr8L-bEi9Ed-g"

RESPONSE

{
  "data": {
    "items": [
      {
        "title": "Senior full stack Developer",
        "department": "Engineer",
        "industry": "Aerospace",
        "remote": false,
        "country_code": "AU",
        "country_name": "Australia",
        "city": "Sydney, New South Wales 2000",
        "employment_type_name": "Full-time",
        "employment_term_name": "Permanent",
        "experience_level_name": "Associate",
        "hide_pay_rate": false,
        "salary_currency": "AUD",
        "salary_min": 50000.0,
        "salary_max": 100000.0,
        "salary_rate_name": "Annum",
        "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
        "created_at": "2021-04-14T03:27:17Z",
        "recruitment_logo": "https://eh.com/logo.png",
        "application_url": "https://jobs.employmenthero.com/jobs/97c42fdb-8af9-4f58-9d16-fe3fed472a85"
      }
    ],
    "item_per_page": 20,
    "page_index": 1,
    "total_pages": 1,
    "total_items": 2
  }
}

Returns a collection of the public jobs for an organisation

HTTP Request

GET https://api.employmenthero.com/ats/api/v1/embedded/organisations/:org_id/jobs

Parameter	Description
org_id uuid - required	The ID of the organisation to retrieve
query string - optional	query string
country_codes array - optional	The array of country codes to filter
department_ids array - optional	The array of department ids to filter

Return

A hash with a data property that contains an item array of public jobs for an organisation. Each entry in the array is a separate job object.

Get All Countries

curl "https://api.employmenthero.com/ats/api/v1/embedded/organisations/c12e0363-17b0-4f4b-99c7-09adea9f12ad/countries" -H "X_ATS_TOKEN: a9207tx3NBr8L-bEi9Ed-g"

RESPONSE

{
  "data": {
    "items": [
      {
        "id": "AU",
        "name": "Australia"
      },
      {
        "id": "NZ",
        "name": "New Zealand"
      }
    ],
    "item_per_page": 20,
    "page_index": 1,
    "total_pages": 1,
    "total_items": 2
  }
}

Returns a collection of the countries listed in the role for an organisation

HTTP Request

GET https://api.employmenthero.com/ats/v1/embedded/organisations/:org_id/countries

Parameter	Description
org_id uuid - required	The ID of the organisation to retrieve

Return

A hash with a data property that contains an item array of the countries listed in the role for an organisation. Each entry in the array is a separate country object.

Get All Departments

curl "https://api.employmenthero.com/ats/api/v1/embedded/organisations/c12e0363-17b0-4f4b-99c7-09adea9f12ad/departments" -H "X_ATS_TOKEN: a9207tx3NBr8L-bEi9Ed-g"

RESPONSE

{
  "data": {
    "items": [
      {
        "id": "aa477f75-6e62-4f5d-abc0-7ef7542e4fb6",
        "name": "Engineer"
      },
      {
        "id": "aa477f76-6c64-4f5e-acc2-7e4r542e4fb8",
        "name": "Marketing"
      }
    ],
    "item_per_page": 20,
    "page_index": 1,
    "total_pages": 1,
    "total_items": 2
  }
}

Returns a collection of the public departments for an organisation

HTTP Request

GET https://api.employmenthero.com/ats/v1/embedded/organisations/:org_id/departments

Parameter	Description
org_id uuid - required	The ID of the organisation to retrieve

Return

A hash with a data property that contains an item array of public departments for an organisation. Each entry in the array is a separate department object.