curl --request GET \
--url https://assess.praxicraft.com/api/v1/public/assessments/{slug}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/{slug}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/assessments/{slug}/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"title": "Senior Backend Engineer Screen",
"slug": "senior-backend-screen",
"description": "A 3-task technical screen.",
"status": "active",
"task_count": 3,
"time_limit_minutes": 90,
"passing_score": 70,
"invitation_count": 12,
"enforce_fullscreen": true,
"copy_paste_disabled": false,
"created_at": "2025-03-01T10:00:00Z",
"updated_at": "2025-03-20T14:30:00Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"message": "Invalid or revoked API Key.",
"code": "INVALID_API_KEY"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Retrieve assessment detail
Required scope:
assessments:read
Returns full configuration for a single assessment: time limit, passing score, proctoring flags, and counts. Path {slug} is the assessment URL slug from create/list (e.g. core-data-engineers-cohort-admission-assessment), not the human title. UUID id is also accepted. Use GET /assessments/{slug}/tasks/ for the attached task list.
Responses
| Status | When |
|---|---|
200 | Assessment detail |
404 | Assessment not found or not owned by your organisation |
Authentication & rate limits (all endpoints)
| Status | Code | When |
|---|---|---|
401 | INVALID_API_KEY | Missing or invalid bearer token |
401 | EXPIRED_API_KEY | API key past its optional expires_at |
403 | INSUFFICIENT_SCOPE | API key lacks the required scope for this operation |
403 | IP_NOT_ALLOWED | Client IP is outside this key’s CIDR allowlist |
429 | RATE_LIMITED | Rate limit exceeded — plan-tiered reads/writes per organisation per hour |
curl --request GET \
--url https://assess.praxicraft.com/api/v1/public/assessments/{slug}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/{slug}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/assessments/{slug}/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"title": "Senior Backend Engineer Screen",
"slug": "senior-backend-screen",
"description": "A 3-task technical screen.",
"status": "active",
"task_count": 3,
"time_limit_minutes": 90,
"passing_score": 70,
"invitation_count": 12,
"enforce_fullscreen": true,
"copy_paste_disabled": false,
"created_at": "2025-03-01T10:00:00Z",
"updated_at": "2025-03-20T14:30:00Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"message": "Invalid or revoked API Key.",
"code": "INVALID_API_KEY"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Organisation API key created in Assess → Developer → API Keys. Format: Bearer ct_live_<your-key> (live) or Bearer ct_test_<your-key> (test). Optional per-key CIDR allowlists return 403 IP_NOT_ALLOWED.
Path Parameters
Response
200100^[-a-zA-Z0-9_]+$Show child attributes
Show child attributes
draft, active, archived 0 <= x <= 21474836470 <= x <= 2147483647Each candidate is assigned a random subset of cases from the pool
How many cases each candidate gets (must be <= total cases in assessment)
0 <= x <= 32767How cases are selected from the pool
random, balanced, tag_balanced, tag_difficulty_balanced, track_balanced Per-tag or tag:difficulty counts for tag-balanced strategies, e.g. {"python": 10, "sql": 10} or {"python:easy": 5, "sql:hard": 3}
Advanced pool options: tag_quota_mode, assignment_seed_mode, display_order_mode, mandatory_case_ids, shuffle_display_order
Total proctoring violations at or above this count require org integrity review.
0 <= x <= 32767True for live hiring. False for isolated test-mode assessments.