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

# API reference

> Every Blue Collar API endpoint, with its request and response schema.

```text Base URL theme={null}
https://api-bc.userecord.io/api/v1/partner
```

You need two things: your **key id** and your **secret**. The signature, timestamp and `Idempotency-Key` are generated for you. Copy the `call()` helper from [Authentication](/blue-collar-api/authentication#signing-helper) first: the code samples on each endpoint page use it.

## Try it

Every endpoint page has a **Try it** button. Enter your key id in `x-api-key` and your secret in `x-secret-key`, fill the request and press **Send**. `x-secret-key` is only a form field: the page signs the request in your browser and removes the secret before sending. See [Why does Try it say `x-secret-key`?](/blue-collar-api/authentication#why-does-try-it-say-x-secret-key).

## On each endpoint page

* **Scope**: the scope the key needs. Any one listed is enough.
* **Idempotency-Key**: whether the endpoint needs one, accepts one, or ignores it. Try it makes one for you.
* **Responses**: the success answer and the errors specific to that endpoint. Errors any endpoint can return, such as `401`, `429` and `500`, are listed in [Errors](/blue-collar-api/reference/errors).

## Endpoints

| Group | What it covers |
| - | - |
| Workflows | How and when candidates are contacted. |
| Job mandates | The job: skills, screening questions and checks. |
| Skills | Search and browse the skill taxonomy, and request missing skills. |
| Lookups | Places in India, countries, employment types and shifts. |
| Campaigns | Send candidates and manage the campaign. |
| Results | Result records, candidate rows and verdicts. |
| Webhooks | Endpoints that receive result events, and their delivery logs. |
| Events | Pull result events and confirm them in the same call. |
| Analytics | Funnel, channel and drop-off numbers. |


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