Skip to main content
Use this when you are building software against Assess. Recruiters and ops can stay in the dashboard or start at Quickstart.

​
Open the API docs

ReDoc

Live reference for every Public API endpoint. Jobs are listed first, then applications and screening.

Authentication

Keys, Bearer auth, and base URL before you call anything.
Direct link: https://assess.praxicraft.com/api/v1/public/redoc/ Use the API Reference tab in these docs for the Mintlify OpenAPI playground (snapshot openapi.json, currently 1.8.0). Tag groups start with Jobs.
  1. Jobs — create and publish openings
  2. Applications — list, advance, reject
  3. Screening — match scores and reruns
  4. Assessments / invitations — invite above-threshold candidates
  5. Pipelines, interviews, soft offers as needed
Assessment-only orgs can skip Jobs and start at Assessments.

​
Current surface (1.8.0)

Guides: Jobs · Screening · Candidate profiles · Organisation · Pipelines · Scopes · Webhooks.

​
Playground notes

  • Auth: Bearer token (ct_live_… or ct_test_…)
  • Server: https://assess.praxicraft.com (paths under /api/v1/public/…)
  • Example languages: curl, Python, JavaScript, Node, Go
Paste keys only in trusted environments. Prefer SDKs for production apps.

​
Schema files

​
Conventions

  • Flat JSON success bodies
  • Errors: { "error": { "code", "message", "details?" } }
  • Invitation id: invite_token
  • Job path id: slug or UUID
  • Cursor pagination: cursor, page_size (default 20, max 100)
  • Audit export format query: export_format (csv | json). not ?format= (DRF renderer)

​
Guides

Quickstart

First call in five minutes.

Jobs & screening

Openings, applications, and match scores.

API changelog

Public API release notes (separate from the product changelog).

Organisation

Usage, billing, health, squads, audit export.

Errors

Stable error.code catalogue.
Last modified on September 5, 2026