1. Guides
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. Guides

Pagination & filtering

Pagination#

Collection endpoints accept:
ParameterDescription
pageOne-based page number. Default: 1.
pageSizeRecords per page. Default: 10; maximum: 100.
Paginated responses use the canonical
{ data, meta: { pagination } } envelope. Use the pagination metadata rather
than inferring the last page from its item count.

Candidate filters#

GET /candidates supports:
ParameterDescription
job_idRestrict results to a job in the credential's CVViZ account.
statusRestrict results to a workflow status. Requires job_id.
updated_sinceReturn profiles updated at or after an RFC 3339 timestamp. A timezone is required.

Candidate stages and applications#

GET /jobs/{jobId}/candidate-stages returns the configured hiring pipeline for
a job. Use the stage code to interpret per-job candidate status values. A
negative stage code represents a rejection stage.
GET /candidates/{candidateId}/applications returns the jobs associated with a
candidate and the candidate's current stage in each job. appliedAt is the
earliest known association with the job; updatedAt is the most recent known
application update.

Example: candidates updated for a job#

Replace 901 with your job ID. Add only filters documented by that endpoint;
do not assume a filter supported by candidates is also supported by jobs.

Dates and units#

Use RFC 3339 timestamps with a timezone, for example 2026-09-01T00:00:00Z.
Job experience bounds are in years; candidate experienceMonths is in
months. Read field descriptions before comparing values across resources.

Synchronization limits#

Page-based results can change while you read them. Deduplicate by resource ID.
Candidate updated_since filters profile updates; it is not a complete event
feed for every related note, application or deletion. Do not assume snapshot
pagination or deletion notifications that the reference does not promise.
Previous
Find candidates and download resumes
Next
Rate limits & usage
Built with