API reference - Vort Partner API

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	`https://vort-partner-api.vercel.app/sandbox/v1`
Production	Issued at go-live, after 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.

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.

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.
Rate limits are per partner (default 120 per minute, 20,000 per day); 429 carries Retry-After. See Errors, rate limits and retries.

Endpoints

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

Webhooks Vort sends to you: run_completed, run_failed, candidate_revealed.

⌘I