// API docs · REST · v1 · bearer token · private beta

REST API reference.

JSON-in / JSON-out, bearer-token auth, URL-versioned. Available on Recruit ($199/mo) and above. Tokens generated in Settings → API keys.

Private beta: the public vanity host api.tryopsticket.com is being provisioned. Recruit-tier beta partners receive a direct backend URL while DNS lands. Endpoint paths, auth, payload shapes, and rate limits below are the GA contract. Request access at [email protected].

Auth + base URL

Base URL:    https://api.tryopsticket.com/v1/

Headers:
  Authorization: Bearer <YOUR_TOKEN>
  Content-Type:  application/json

Example:
  curl https://api.tryopsticket.com/v1/candidates?track=helpdesk \
    -H "Authorization: Bearer ot_live_abc123..."

Tokens are workspace-scoped. Rotate any time without downtime: old tokens stay valid for 30 minutes after rotation. Rate limits: 300 req/min on Recruit; 2,000 req/min on Enterprise+; custom limits negotiable.

Endpoints

GET/v1/candidates

Recruit

↳ List candidates in your workspace · filter by track, score range, posting

GET/v1/candidates/{id}

Recruit

↳ Fetch a candidate · score, grade, rubric breakdown, replay URL, certificate hash

POST/v1/assessments/invite

Recruit

↳ Send an assessment invite to one or more emails · returns invite IDs

GET/v1/assessments/{id}

Recruit

↳ Fetch a completed assessment · transcript, AI scoring rationale, replay manifest

GET/v1/postings

Recruit

↳ List your job postings

POST/v1/postings

Recruit

↳ Create a job posting · track, level, score threshold, comp, description

PATCH/v1/postings/{id}

Recruit

↳ Update a posting

DELETE/v1/postings/{id}

Recruit

↳ Archive a posting

GET/v1/pipeline

Recruit

↳ List pipeline stages and counts

POST/v1/pipeline/{candidate_id}/move

Recruit

↳ Advance a candidate to a new stage · triggers email sequence

POST/v1/webhooks

Recruit

↳ Register a webhook URL · subscribe to event types · HMAC-signed delivery

GET/v1/reports/funnel

Recruit

↳ Pipeline funnel metrics for a date range

GET/v1/reports/skill-gap

Recruit

↳ Aggregated skill-gap report across your team

POST/v1/scenarios

Enterprise

↳ Create a custom AI scenario

GET/v1/orgs

Enterprise+

↳ List child orgs in a multi-org parent

Webhook events

assessment.completed

↳ A candidate finished an assessment · payload: candidate_id, assessment_id, score, grade, hash

candidate.applied

↳ A candidate applied to a posting · payload: candidate_id, posting_id, score

stage.changed

↳ Pipeline stage moved · payload: candidate_id, from_stage, to_stage, actor

invite.bounced

↳ An assessment invite email bounced · payload: invite_id, email, reason

cert.verified

↳ Someone hit /verify/HASH for a cert from your org · payload: cert_id, verifier_ip, ts

webhooks are HMAC-signed (header: X-OT-Signature) · we retry with exponential backoff for 24 hours · responses ≥ 200 and < 300 are considered delivered

Need an SDK or sample integration?

We have reference implementations in Node, Python, and Go. Email us for early access.

[email protected]API overview

// loading

REST API reference.

JSON-in / JSON-out, bearer-token auth, URL-versioned. Available on Recruit ($199/mo) and above. Tokens generated in Settings → API keys.

Auth + base URL

Base URL: https://api.tryopsticket.com/v1/ Headers: Authorization: Bearer <YOUR_TOKEN> Content-Type: application/json Example: curl https://api.tryopsticket.com/v1/candidates?track=helpdesk \ -H "Authorization: Bearer ot_live_abc123..."

Endpoints

GET/v1/candidates

Recruit

↳ List candidates in your workspace · filter by track, score range, posting

GET/v1/candidates/{id}

Recruit

↳ Fetch a candidate · score, grade, rubric breakdown, replay URL, certificate hash

POST/v1/assessments/invite

Recruit

↳ Send an assessment invite to one or more emails · returns invite IDs

GET/v1/assessments/{id}

Recruit

↳ Fetch a completed assessment · transcript, AI scoring rationale, replay manifest

GET/v1/postings

Recruit

↳ List your job postings

POST/v1/postings

Recruit

↳ Create a job posting · track, level, score threshold, comp, description

PATCH/v1/postings/{id}

Recruit

↳ Update a posting

DELETE/v1/postings/{id}

Recruit

↳ Archive a posting

GET/v1/pipeline

Recruit

↳ List pipeline stages and counts

POST/v1/pipeline/{candidate_id}/move

Recruit

↳ Advance a candidate to a new stage · triggers email sequence

POST/v1/webhooks

Recruit

↳ Register a webhook URL · subscribe to event types · HMAC-signed delivery

GET/v1/reports/funnel

Recruit

↳ Pipeline funnel metrics for a date range

GET/v1/reports/skill-gap

Recruit

↳ Aggregated skill-gap report across your team

POST/v1/scenarios

Enterprise

↳ Create a custom AI scenario

GET/v1/orgs

Enterprise+

↳ List child orgs in a multi-org parent

Webhook events

assessment.completed

↳ A candidate finished an assessment · payload: candidate_id, assessment_id, score, grade, hash

candidate.applied

↳ A candidate applied to a posting · payload: candidate_id, posting_id, score

stage.changed

↳ Pipeline stage moved · payload: candidate_id, from_stage, to_stage, actor

invite.bounced

↳ An assessment invite email bounced · payload: invite_id, email, reason

cert.verified

↳ Someone hit /verify/HASH for a cert from your org · payload: cert_id, verifier_ip, ts

webhooks are HMAC-signed (header: X-OT-Signature) · we retry with exponential backoff for 24 hours · responses ≥ 200 and < 300 are considered delivered