Retrieve a job board URL and create an API key for a partner integration

Permissions: Basic users and above who can manage and configure webhooks

Product tier: Available for all subscription tiers

When configuring a Job Board partner for a Greenhouse application, you’ll have to provide your Job Board URL so the partner knows where the job posts are located. In some cases, you may have to create a Job Board API key to get the integration to work.

To see the full Job Board API developer documentation, click here.

Configure your job board

To make your open jobs available to a partner, you’ll need to create a job board URL and send it to the vendor.

To locate a job board, click the Configure icon Icon_-_Configure__redesign_.png and select Job Board & Posts on the left side of the page.

Screenshot-of-Job-Boards-and-Posts-Navigation.png

Select the Ellipsis icon next to your job board and click Edit Board Settings.

Screenshot-of-edit-board-settings.png

Scroll down to the URL field and write down the URL.

Screenshot-of-Job-Board-URL-field.png

Generate a job board API key

If a partner is uploading candidates directly to your Greenhouse Recruiting organization, they may ask you to create a Job Board API Key and add it to their application. This process allows the two pieces of software to communicate.

Note: To complete these steps, you must have the developer permission Can manage ALL organization's API Credentials.

A Site Admin with the user-specific permission Can edit another user's advanced permissions can update your account. Click here for more information on updating permissions.

Click on the Configure icon Screenshot of configure icon and select Dev Center on the left side of the page.

Screenshot of Dev Center Navigation

Select API Credential Management in the Dev Center.

Screenshot of API credential management

Click Create New API Key.

Screenshot of create new API key button.

Choose the Job Board API Type and put the partner’s name in the description field. When you’re finished, click Create.

Screenshot of job board API credential

After you create a new API key, you’ll be prompted to copy it so you can provide it to the partner. Click Copy to save your API key to your clipboard.

Note: Make sure to store the API key in a secure location to provide to the partner in the next step.

Each key is unique, and for security purposes, you won’t be able to view it after it has been generated on this window.

If you lose the API key, you’ll need to generate a new one and provide it to the partner.

Screenshot of a copied API key

Click I have stored the API Key once you have copied and saved the key.

Screenshot of storage button

To finish setup, send the API key to the partner through a secure method. Make sure to communicate with the partner and use their process for sending secure information.

Once the partner adds your organization’s information to their system, the integration setup is complete.