> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://support.careerfairy.io/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# ATS integration - How to get the API key for Greenhouse

# How to retrieve the API key and other configurations for Greenhouse ATS system 

Before starting the integrating your Greenhouse ATS system with CareerFairy, you need to prepare your ATS system to receive applications from our platform. It's just one action: please add in your Greenhouse ATS system the value "CareerFairy" for the field SOURCE, so that the application coming from our platform can be correctly tagged. The name must be exactly "CareerFairy" otherwise your ATS system will not match it and won't display any source at all.

That was it.! Simple and quick. 

Now we help you getting the Greenhouse API key to link it to the CareerFairy platform.

**Step 1**

Log in and click the **Configure (Settings) Icon** on the upper right-hand corner of any page.

![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1146_1ii01mh.png)

**Step 2**

Click **Dev Center** in the left menu.

![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1149_uw3v5d.png)

**Step 3**

Select **API Credential Management**.

![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1150_172kbef.png)

**Step 4**

Click the **Create New API Key** button.

![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1152_1pzjv8y.png)

**Step 5**

Select **Harvest** for the API Type. Enter a description for the API key and click **Manage Permissions**.

![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1153_1e7bkf7.png)

**Step 6**

Click the **Copy** button, and paste the API key below. Next, click **I have stored the API key**. 

![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/cleanshot-2022-10-05-at-152341_g57ytw.png)
_Please note: you will not be able to copy this API Key again, so please store it somewhere safe!_

**Step 7**

Please see below all of the permissions categories for the integration with the CareerFairy platform. 

![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1159_131347a.png)

**Step 8**

Select the relevant permissions. Please note that the permissions shown below are the minimum requirement needed to correctly sync your account. Please reach out to CareerFairy if you are unsure which permissions you need for your Greenhouse integration.


![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/permissions-1_1k3r21q.png)
![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1207_w4x8fz.png)
![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1207_5t17ao.png)
![](https://storage.crisp.chat/users/helpdesk/website/cb805c216b7a1000/screen-shot-2022-09-29-at-1207_1tm8rm5.png)

-------

**Congratulations!**

You have now generated an API key to integrate Greenhouse with the CareerFairy platform. You can consult the "How to integrate your ATS system with CareerFairy" [article](https://support.careerfairy.io/en/article/how-to-integrate-your-ats-system-with-careerfairy-15sqrlt/) to finalise the synchronisation.