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 — schemas, examples, try-it.

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.4.0).

​
Current surface (1.4.0)

Additive org/ops endpoints since the 1.1.0 baseline — details in the API changelog: Guides with curl and Live/Test callouts: 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
  • 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.

Authentication

Keys and scopes.

API changelog

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

Organisation

Usage, billing, health, squads, audit export.

Errors

Stable error.code catalogue.

SDKs

Python, Node.js, Go.
Last modified on August 24, 2026