> ## 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.

# Integration guidelines

> Keep recruiting workflows reliable when actions continue in the background or requests need to be retried.

## Credentials

Create API keys in [Jobin integrations](https://my.jobin.cloud/workgroups/integrations) under
**Custom integration**. Send the key in `x-api-key` and verify it with `GET /auth/validate`.

## Complete actions in order

1. Search or fetch the target contact.
2. Request enrichment when required fields are missing.
3. Check `GET /contacts/{contactId}` for those fields. Increase the time between checks and stop after a set waiting period.
4. Assign the contact to a campaign to launch the configured sequence.

People Search, enrichment, and campaign assignment can spend credits or create background work.
Check the result before retrying an interrupted request.

## Handle errors and retries

| Status | What to do |
| - | - |
| `400` | Review the error message and correct the request. |
| `401` | Check your API key and connection settings. |
| `404` | Check the resource identifier and the connected workgroup. |
| `429` | Wait for the `retry-after` interval before trying again. |
| `5xx` | Check whether the action took effect, then retry if appropriate. Increase the wait between attempts. |

Most errors return `{ code, error }` with a message your assistant or tool can display. API key validation returns
`{ valid: false, error }`; endpoint rate-limit responses include `retryAfterSeconds`.
A `202` response means Jobin queued the work. Check the relevant contact or operation afterward.

## Rate limits

Each endpoint has a request limit. Authenticated endpoint budgets are shared by all API keys in
the workgroup, and a general **1,000 requests per minute per source IP** limit applies across endpoints.

| Request | Limit per minute |
| - | - |
| General traffic across endpoints | 1,000 per source IP |
| Authenticated endpoint baseline, including reads | 120 per endpoint and workgroup |
| Contact lists with `includeTotal=true` | 60 per endpoint and workgroup |
| Writes | 30 per endpoint and workgroup |
| People Search, enrichment, campaign assignment/removal, event downloads | 10 per endpoint and workgroup |
| API key validation | 30 per workgroup for recognized keys; unrecognized keys and requests without a key have separate 30/minute limits |

Action-specific limits apply alongside the authenticated baseline and general limit.
Requests for different contact or campaign IDs share the same action's limit.

Read `x-ratelimit-limit`, `x-ratelimit-remaining`, and `x-ratelimit-reset` for the applicable
budget. For `429` responses, wait for `retry-after` seconds and use exponential backoff for repeated retries.


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