API reference
CVViZ API1.8.0
Versioned API for customer and partner integrations.
Authentication
Create a CVViZ API credential in Developer settings and send it as Authorization: Bearer <api-credential>. A credential can access only its CVViZ account and every operation requires the scopes documented on that operation.
Versioning
The URL major version (/v1) changes only for breaking contracts. Backward-compatible endpoints and optional response fields may be added within v1. Clients must ignore unknown response fields.
Deprecation
A generally available endpoint receives at least 180 days notice before removal. Deprecations are recorded in the changelog and responses will include Deprecation and Sunset headers during the announced migration window.
Changelog
- 1.8.0 - 2026-09-11: POST /jobs now follows the account workflow by default: active when approval is disabled, pending approval when enabled. Use saveAsDraft=true for an explicit draft. Creation requires jobs.write; jobs.status.write remains required for later lifecycle changes.
- 1.7.0 - 2026-09-11: Added optional atomic active job creation with jobs.write and jobs.status.write, lifecycle options, and job status/approval labels. Draft remains the default; approval, capacity, and publication safeguards remain enforced.
- 1.6.0 - 2026-09-10: Added draft job creation under jobs.write and supporting reference data, candidate resume metadata and authenticated downloads, optional short-lived direct URLs, and primary candidate employment/contact details. Resume file access requires resumes.download.
- 1.5.0 - 2026-09-02: Added job-tag reads and idempotent writes, changed the default page size to 10, removed the Candidate Database pre-screening route, and temporarily removed candidate creation, candidate document management, and resume imports from the published contract.
- 1.4.0 - 2026-09-01: Added candidate and application management, organization lookups, candidate document and resume intake, tasks, and bounded job updates and status changes. Job creation and job-board settings remain unavailable.
- 1.3.0 - 2026-09-01: Added scoped read resources for tags, notes, screening, benchmark resumes, offers, events, documents, and interview feedback; added idempotent writes for tags, notes, and candidate application stages.
- 1.2.0 - 2026-09-01: Added job candidate-stage definitions and candidate application history. Published concise customer-facing schema names.
- 1.1.1 - 2026-09-01: Normalized the OpenAPI server URL to the
/v1API root; operation URLs are unchanged. - 1.1.0 - 2026-09-01: Added account-wide
GET /v1/candidateswith pagination andjob_id,status, andupdated_sincefilters. - 1.0.0 - 2026-09-01: Initial read-only jobs and candidates API.
All requests use this base URL:
https://api.cvviz.com/v1Production
curl --request GET \
--url https://api.cvviz.com/v1/jobs \
--header 'Authorization: Bearer <token>'Still need help? Ask the team