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

# API reference

> Every endpoint and webhook of the Vort Partner API v1, generated from the OpenAPI 3.1 document.

export const SANDBOX_BASE = "https://vort-partner-api.vercel.app/sandbox";

The pages in this section are generated from the Partner API's OpenAPI 3.1 document. Use the page menu to download the spec for client generation and contract tests.

## Base URL

| Environment | Base URL |
| - | - |
| Sandbox | <code>{SANDBOX_BASE}/v1</code> |
| Production | Issued at go-live, after [certification](/certification). |

Every path in this reference is relative to the base URL, which already includes `/v1`. Keep the base URL in configuration so it can change without a release.

## Authentication

Every request carries `x-partner-key`. Every request except `POST /activations/redeem` also carries the customer's org token in `x-vort-org`. See [Authentication](/authentication).

<Warning>
  There is no "try it" console on these pages, by design: Vort keys and org tokens MUST NOT be typed into or held by a browser. Run the generated examples from a terminal or from your server.
</Warning>

## Conventions

* `x-vort-lang: he|en` selects the language of notices and messages.
* Clients MUST ignore unknown response fields; additive changes within v1 are non-breaking.
* Notices with an unknown `code` MUST be rendered generically. See [Notices](/notices).
* Rate limits are per partner (default 120 per minute, 20,000 per day); `429` carries `Retry-After`. See [Errors, rate limits and retries](/errors).

## Endpoints

| Method | Path | Page |
| - | - | - |
| `POST` | `/activations/redeem` | [Redeem activation code](/api-reference/activation/redeem) |
| `POST` | `/users` | [Register a recruiter](/api-reference/users/register) |
| `POST` | `/jobs` | [Create or update a job](/api-reference/jobs/upsert) |
| `POST` | `/runs` | [Start a run](/api-reference/runs/start) |
| `GET` | `/runs/{run_id}` | [Get a run](/api-reference/runs/get) |
| `POST` | `/runs/{run_id}/candidates/{candidate_id}/reveal` | [Reveal contact details](/api-reference/candidates/reveal) |
| `POST` | `/runs/{run_id}/decisions` | [Report decisions](/api-reference/decisions/report) |
| `POST` | `/sandbox/webhooks/test` | [Send a test webhook](/api-reference/sandbox/test-webhook) (sandbox only) |

Webhooks Vort sends to you: [run\_completed](/api-reference/webhooks/run-completed), [run\_failed](/api-reference/webhooks/run-failed), [candidate\_revealed](/api-reference/webhooks/candidate-revealed).