Create invitation
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"expires_days": 7,
"send_email": false,
"external_id": "<string>",
"extra_time_percent": 0,
"tags": [
"<string>"
]
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/"
payload = {
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"expires_days": 7,
"send_email": False,
"external_id": "<string>",
"extra_time_percent": 0,
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '[email protected]',
name: '<string>',
role: '<string>',
expires_days: 7,
send_email: false,
external_id: '<string>',
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/', 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}/invites/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '[email protected]',
name: '<string>',
role: '<string>',
expires_days: 7,
send_email: false,
external_id: '<string>',
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"expires_days\": 7,\n \"send_email\": false,\n \"external_id\": \"<string>\",\n \"extra_time_percent\": 0,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "Invitation already exists.",
"invite_token": "8e909a4f-aa4c-40cb-9623-485d2879cb3b",
"invite_url": "https://assess.praxicraft.com/take/8e909a4f-aa4c-40cb-9623-485d2879cb3b",
"expires_at": "2025-03-22T10:00:00Z",
"status": "pending"
}Public API — Invitations
Create invitation
Required scope:
invitations:write
Creates a unique assessment link for one candidate. Idempotent: if the email was already invited, or if external_id matches an existing invite on this assessment, returns the existing invitation with HTTP 200 (not 201). Set send_email: true to dispatch the email immediately. extra_time_percent must be 0, 25, 50, or 100. Optional tags are stored on the invitation. Counts against your monthly invite quota unless you are on the enterprise plan.
Responses
| Status | Code | When |
|---|---|---|
201 | — | New invitation created |
200 | — | Invitation already exists for this email (idempotent) |
400 | ASSESSMENT_NOT_ACTIVE | Assessment is draft or archived |
400 | MISSING_EMAIL | email field is empty |
403 | INVITE_QUOTA_EXCEEDED | Monthly invite quota exhausted |
404 | — | Assessment slug not found |
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 |
POST
/
api
/
v1
/
public
/
assessments
/
{slug}
/
invites
/
Create invitation
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"expires_days": 7,
"send_email": false,
"external_id": "<string>",
"extra_time_percent": 0,
"tags": [
"<string>"
]
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/"
payload = {
"email": "[email protected]",
"name": "<string>",
"role": "<string>",
"expires_days": 7,
"send_email": False,
"external_id": "<string>",
"extra_time_percent": 0,
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '[email protected]',
name: '<string>',
role: '<string>',
expires_days: 7,
send_email: false,
external_id: '<string>',
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch('https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/', 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}/invites/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '[email protected]',
name: '<string>',
role: '<string>',
expires_days: 7,
send_email: false,
external_id: '<string>',
extra_time_percent: 0,
tags: ['<string>']
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/assessments/{slug}/invites/"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"expires_days\": 7,\n \"send_email\": false,\n \"external_id\": \"<string>\",\n \"extra_time_percent\": 0,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "Invitation already exists.",
"invite_token": "8e909a4f-aa4c-40cb-9623-485d2879cb3b",
"invite_url": "https://assess.praxicraft.com/take/8e909a4f-aa4c-40cb-9623-485d2879cb3b",
"expires_at": "2025-03-22T10:00:00Z",
"status": "pending"
}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
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Last modified on September 5, 2026