> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jobin.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# How to connect any tool to Jobin with a custom integration

> Connect software Jobin doesn't integrate with yet: create an API key and use the Jobin API to work with contacts, sequences, and more.

To connect any tool to Jobin with a custom integration, click **Create API Key** on the **Custom Integration** card, copy the key, and send it in the `x-api-key` header of requests to the Jobin API.

Use a custom integration to connect a tool that isn't in the Integrations list. You create an API key, and your tool calls
the Jobin API with it.

## What this gets you

* Software Jobin doesn't integrate with yet can still work with your data.
* Your tool can find and update contacts, work with sequences, and check queued operations.
* Each tool can have its own key.

## What it does

A custom integration gives your tool the same access as any other API key in the workgroup. With it, your tool can:

| Area | What you can do |
| - | - |
| **Contacts** | Find, import, and update contacts; read profiles; add notes, tags, CVs, and tasks; request enrichment; read activity. |
| **Sequences** | List sequences, review one, and add or remove contacts. The API calls a sequence a *campaign*. |
| **Operations** | Check queued and processing background work. |
| **People search** | [Find new people](/api-reference/people/search-people.md) and save them to your Jobin contacts. Review the plan requirements and charges on that page first. |
| **Connection** | Check that your API key is valid. |

Examples of what you could build: syncing Jobin with an internal database, building a custom report, or connecting software that
Jobin doesn't integrate with yet.

## Before you begin

* A tool or script that can send HTTPS requests with a custom header.
* A Jobin account. API keys belong to the workgroup where you create them, so create yours in the workgroup you want to use.

## Connect your tool

**1. Create the key**

Open [Jobin integrations](https://my.jobin.cloud/workgroups/integrations) and click **Create API Key** on the
**Custom Integration** card. Or click **New API Key** in the page header and choose **Custom integration**.

**2. Label it**

Enter an **API Key Label** that describes what the key is for, then click **Generate API Key**.

**3. Copy the key**

Copy the key before you close the window. Jobin shows it only once.

**4. Call the API**

Send the key in the `x-api-key` header with each request to `https://my.jobin.cloud/api/openapi/v1`.
See [Authentication](/api-reference/authentication.md).

**5. Test it**

Test with [Validate API key](/api-reference/authentication/validate-api-key.md) before you build on it.

Test with a tool such as curl or Postman first, before you wire the key into your own code.

## Give your tool the API definitions

Your tool or AI assistant can load the [OpenAPI specification](/openapi/jobin-integration.json) to see every action and field.
See [OpenAPI specification](/api-reference/openapi.md) for how to use it.

## Security best practices

* Store keys securely and never expose them in client-side code.
* Rotate keys regularly.
* Give each tool its own key so you can delete one without affecting the others.

## Manage the connection

The key appears on the **API Keys** tab. To disconnect, delete it. Any tool that still uses it will start receiving `401` errors.
See [API keys](/integrations-api-keys.md).

## Ideas to get more from it

* Sync Jobin with an internal database.
* Build a custom report from your contact data.
* Give your AI assistant or automation tool the OpenAPI specification so it knows every action.

## Related

> **[API introduction](/api-reference/introduction.md)**
>
> Start with the API.

> **[Request an integration](/request-integration.md)**
>
> Ask for a ready-made integration.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.