> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/indeed-integration-setup.md).

# Indeed Integration Setup

### Getting Started

Use this guide to connect Indeed to your BalkanID tenant. You will need credentials from the Indeed Partner Console and access to the Integrations section in BalkanID.

{% hint style="info" %}
The Indeed SCIM API is available to Indeed partners with an application registered in the Indeed Partner Console. If your organisation does not have one yet, contact Indeed to have it set up before you begin.
{% endhint %}

#### Requirements:

Before you begin, collect the following values from Indeed:

* **Client ID**
* **Client Secret**
* **Employer ID** (optional)

### Configure Indeed within your BalkanID tenant

1. To find the Client ID and Client Secret, sign in to the [Indeed Partner Console](https://console.indeed.com/) with your Indeed account.
2. Select your application from the **Apps** list on the Dashboard.
3. Open the **Credentials** tab and copy the **Client ID** and **Client Secret**.
4. If you manage more than one employer account and want this integration to cover a single one, note that employer's ID. Leave it blank to cover every employer account the application can reach.
5. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FcNrQ0gIrA6swLxneDHpD%2Findeed-add-integration.png?alt=media" alt="The Integrations page with the Add integration button in the top right"><figcaption><p>Integrations</p></figcaption></figure></div>

6. Search for **Indeed**, select it, and click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FmT2tZpj2rbeBLxRAN9Pe%2Findeed-connect-application.png?alt=media" alt="Indeed selected in the Connect a new application step"><figcaption><p>Connect a new application</p></figcaption></figure></div>

7. Set the **Primary application owner** and a **Description**, if any. Set **Secondary application owner(s)**, if any.
8. Under **Select Extraction Type**, keep **Direct Configuration** selected and paste your **Client ID** and **Client Secret**. Enter an **Employer ID** if you noted one in step 4, then click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FG6egyBJBZBZqgyt2FVk5%2Findeed-direct-configuration.png?alt=media" alt="The Direct Configuration fields for Client ID, Client Secret and Employer ID"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

9. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step of the integration wizard"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

10. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### Integration Scopes

| Read Only Scopes                                                                                                                                                                                        | Lifecycle Management Scopes |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| **Employer access (Read)** — reads the users in your Indeed employer account, including each user's name, email address, status, job title, employer organisation and whether they hold the admin role. | N/A                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/indeed-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
