Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
How to authenticate with the Credentials Portal API using session tokens or API keys.
ck_ followed by a random string:
ck_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
Authorization header:
Authorization: Bearer ck_your_api_key_here
| Scope | Access |
|---|---|
read:people | List and get people |
write:people | Create and update people |
read:interviews | List and get interviews |
write:interviews | Create and update interviews |
curl -X POST https://app.credentialsportal.com/api/auth/request \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com"}'
{
"ok": true,
"message": "Check your email"
}
curl -X POST https://app.credentialsportal.com/api/auth/verify \
-H "Content-Type: application/json" \
-d '{"code": "123456"}'
{
"ok": true,
"token": "your_session_token_here",
"person": {
"id": "abc12",
"first": "Jane",
"last": "Doe",
"email": "user@example.com",
"language": "en",
"roles": { "1a": 1 },
"district_id": "xyz99"
},
"district": {
"id": "xyz99",
"name": { "en": "My District" },
"accent": "#6e5dec",
"languages": ["en"],
"billing_plan": "pro"
}
}
GET /api/auth/verify/:token
curl -X POST https://app.credentialsportal.com/api/auth/logout \
-H "Authorization: Bearer your_session_token"
{ "ok": true }
| Token type | Lifetime |
|---|---|
| Session token | 30 days |
| Login code | 10 minutes |
| Magic link | 30 minutes |
| API key | Does not expire (until revoked) |
curl https://app.credentialsportal.com/api/me \
-H "Authorization: Bearer your_token"
{
"person": {
"id": "abc12",
"first": "Jane",
"last": "Doe",
"email": "user@example.com",
"language": "en",
"roles": { "1a": 1 },
"district_id": "xyz99"
},
"districtId": "xyz99"
}