API

Getting Started

The Vouch public API is a read-only REST API for listings, their candidates, and performance data.

Base URL

https://vouch.careers/api/v1

Authentication

Every request needs an Authorization header with a bearer API key:

Authorization: Bearer vch_live_...

Get a key from Settings → API + Webhooks in your Vouch business portal. The full key is shown once, at creation — copy it then, since it can’t be retrieved again afterwards. A key inherits the access of whoever created it (company-wide, or restricted to specific listings if you chose to scope it down when creating the key).

Rate limits

Requests are capped per API key, by default 60 requests/minute. Some keys may be configured with a different limit. Every response includes:

HeaderMeaning
X-RateLimit-LimitRequests allowed per minute for this key
X-RateLimit-RemainingRequests left in the current window
X-RateLimit-ResetUnix timestamp (seconds) when the window resets

Exceeding the limit returns 429 with a Retry-After header (seconds until you can retry).

Pagination

GET /listings/{id}/candidates is cursor-paginated: pass take (max 100, default 50) and cursor (the nextCursor from the previous response) to page through results. nextCursor is null on the last page.

Errors

Errors are returned as { "error": string, "code": string } with a matching HTTP status — 401 (missing/invalid key), 403 (key doesn’t have access to the requested company or listing), 404 (not found), 429 (rate limited).

Importing into Postman

Rather than a separately generated collection file (Fern’s Postman generator is no longer maintained), import the live spec directly — it’s always in sync with what’s actually deployed:

  1. In Postman: File → Import
  2. Choose Link, and paste: 
    https://vouch.careers/api/v1/openapi.json

Postman will build a full collection from it, including request/response schemas for every endpoint.