Assess API · v1
Organisation
Retrieve information about your organisation and team members. Useful for verifying your integration context or building team-aware workflows.
GET
https://praxicraft.com/api/v1/public/org/organisation:readAuth: Bearer ct_live_…
Get Organisation Info
Returns basic information about the organisation associated with your API key, including your plan and current invite quota.
Response Fields
| Field | Type | Description |
|---|---|---|
| name | string | Organisation name |
| slug | string | URL-safe organisation identifier |
| plan | string | Subscription plan: free | starter | growth | enterprise |
| invite_limit | integer|null | Monthly candidate invite quota (null for enterprise) |
| invites_used | integer | Invites used in the current billing cycle |
| invites_remaining | integer|null | Invites remaining in the current cycle (null for enterprise) |
HTTP
GET /api/v1/public/org/ Authorization: Bearer ct_live_xxxxxxxxxxxxxxxx
Example Response
JSON
{
"name": "Acme Corp",
"slug": "acme-corp",
"plan": "starter",
"invite_limit": 100,
"invites_used": 23,
"invites_remaining": 77
}GET
https://praxicraft.com/api/v1/public/org/team/organisation:readAuth: Bearer ct_live_…
List Team Members
Returns all active members of your organisation with their name, email, and role. Useful for ATS integrations that need to attribute assessments to a specific recruiter.
Query / Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| cursor | string | optional | Opaque pagination cursor — pass the value from `next` to fetch the next page |
| page_size | integer | optional | Results per page, max 100 (default: 20) |
Response Fields
| Field | Type | Description |
|---|---|---|
| name | string | Member's full name |
| string | Member's email address | |
| role | string | owner | admin | recruiter | viewer |
| joined_at | ISO 8601 | When the member joined the organisation |
HTTP
GET /api/v1/public/org/team/ Authorization: Bearer ct_live_xxxxxxxxxxxxxxxx
Example Response
JSON
{
"next": null,
"previous": null,
"results": [
{ "name": "Sarah Chen", "email": "sarah@acme.com", "role": "owner", "joined_at": "2024-11-01T09:00:00Z" },
{ "name": "James Okafor", "email": "james@acme.com", "role": "admin", "joined_at": "2025-01-15T10:30:00Z" },
{ "name": "Priya Nair", "email": "priya@acme.com", "role": "recruiter", "joined_at": "2025-02-20T08:00:00Z" }
]
}GET
https://praxicraft.com/api/v1/public/org/stats/organisation:readAuth: Bearer ct_live_…
Get Organisation Analytics
Returns high-level aggregate metrics for your organisation's assessment activity, including pass rates and candidate volume.
Response Fields
| Field | Type | Description |
|---|---|---|
| total_invites | integer | Total invitations sent ever |
| total_candidates | integer | Total candidates who started a session |
| completed_assessments | integer | Sessions completed |
| passed_candidates | integer | Sessions that met the passing score |
| pass_rate | float | Percentage of completed sessions that passed |
| active_assessments | integer | Count of currently active assessments |
HTTP
GET /api/v1/public/org/stats/ Authorization: Bearer ct_live_xxxxxxxxxxxxxxxx
Example Response
JSON
{
"total_invites": 450,
"total_candidates": 380,
"completed_assessments": 365,
"passed_candidates": 210,
"pass_rate": 57.5,
"average_score_percentage": 68.2,
"active_assessments": 12
}