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 plan or an active API add-on must include API access. With administrator or credential-management permission, open Settings → Integrations & Tools → Developers → API credentials → Create credential. Enter a name. For this example, keep View jobs (jobs.read) and remove other unneeded permissions. Review Expiry, then select Create credential.

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.

curl --request GET \
  --url 'https://api.cvviz.com/v1/jobs?page=1&pageSize=10' \
  --header 'Authorization: Bearer YOUR_API_SECRET' \
  --header 'Accept: application/json'

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 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, resume imports, offer sending, destructive job deletion and webhook management are unavailable. Jobs support optional career-page and eligible free-job-board publication, with no individual board selection. Free-job-board publication defaults to off on each create/update request.