1. Start here
CVViZ API Documentation
  • Start here
    • Quickstart
    • Authentication & permissions
  • Guides
    • API concepts
    • Create a job
    • Find candidates and download resumes
    • Pagination & filtering
    • Rate limits & usage
    • Errors & troubleshooting
    • Safe retries & idempotency
  • Jobs
    • Create a job
      POST
    • List jobs
      GET
    • Get a job
      GET
    • Update a job
      PATCH
    • List candidates for a job
      GET
    • List job benchmark resumes
      GET
    • List candidate job offers
      GET
    • Update a candidate application stage
      PATCH
    • Update job status
      PATCH
  • Candidates
    • List candidates
      GET
    • Get a candidate
      GET
    • Update a candidate
      PATCH
    • List applications for a candidate
      GET
    • List candidate events
      GET
    • List candidate documents
      GET
    • Download a candidate resume
      GET
  • Tasks
    • List tasks
    • Create a task
    • Update a task
    • Update task completion
  • Notes & tags
    • List job notes
    • Add a job note
    • List tags for a job
    • Add tags to a job
    • List tags for a candidate
    • Add tags to a candidate
    • List candidate notes
    • Add a candidate note
    • List candidate tags
  • Screening & interviews
    • List job pre-screening questions
    • List candidate screening answers
    • List candidate interview feedback
  • Organization & lookup data
    • List candidate stages for a job
    • Get job creation options
    • List industries
    • List job functions
    • List employer types
    • List client companies
    • List account users
    • List departments
    • List hiring managers
    • List candidate grades
  1. Start here

Quickstart

Connect your systems to the jobs and candidates in your CVViZ account. Start
with a read request, then follow a guide for the workflow you want to build.

1. Get access and create a credential#

Your account needs API access through its plan or an active API add-on.
An authorized administrator can open Settings > Developers,
choose Create credential, and select View jobs (jobs.read) for this example.
Copy the secret immediately: it is shown only once. Keep it on your server,
never in browser code, public repositories, logs or support messages.

2. Send your first request#

The base URL is https://api.cvviz.com/v1. Paths such as /jobs are relative to it.
Replace YOUR_API_SECRET locally. This reads jobs; it does not create or modify them.

3. Understand the response#

A successful request returns 200. Collections contain a data array and
pagination metadata. An account with no matching jobs can return:
{"data":[],"meta":{"pagination":{"page":1,"pageSize":10,"totalItems":0,"totalPages":0}}}
The default page size is 10 and the maximum is 100. Save the X-Request-ID
response header if you need support.

4. Choose your next task#

Create and activate a job.
Find candidates and download resumes.
Pagination & filtering.
Authentication & permissions.
Rate limits & usage.
Errors & troubleshooting.
Safe retries & idempotency.

What is available?#

Read jobs, candidates, applications, screening information, notes, tags and
other documented resources. Selected write operations support jobs, candidate
profiles, application stages, notes, tags and tasks.
Candidate creation, general document upload/download management and resume
imports remain unpublished. Job creation and updates support optional career-page
and eligible free-job-board publication; individual boards are not selectable.
Free-job-board publication defaults to off on each create/update request. Offer sending, destructive
job deletion and webhook management are not supported by this API.
Next
Authentication & permissions
Built with