Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
List, create, update, and delete people in your district via the API.
GET /api/people
| Parameter | Type | Description |
|---|---|---|
archived | boolean | Set to true to include archived people |
curl https://app.credentialsportal.com/api/people \
-H "Authorization: Bearer ck_your_api_key"
[
{
"id": "abc12",
"first": "Jane",
"last": "Doe",
"email": "jane@example.com",
"language": "en",
"roles": { "1c": 1 },
"tags": ["1a"],
"archived": 0,
"avatar_url": null,
"district_id": "xyz99",
"created_at": 1709942400000
}
]
GET /api/people/:id
| Parameter | Type | Description |
|---|---|---|
include | string | Comma-separated list: files, interviews, tags, photo_url |
curl "https://app.credentialsportal.com/api/people/abc12?include=files,interviews" \
-H "Authorization: Bearer ck_your_api_key"
{
"id": "abc12",
"first": "Jane",
"last": "Doe",
"email": "jane@example.com",
"language": "en",
"roles": { "1c": 1 },
"tags": ["1a"],
"archived": 0,
"avatar_url": "https://...",
"district_id": "xyz99",
"created_at": 1709942400000,
"files": [...],
"interviews": [...]
}
POST /api/people
"en"){ roleId: 1 } (1 = primary, 2 = secondary)curl -X POST https://app.credentialsportal.com/api/people \
-H "Authorization: Bearer ck_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"first": "John",
"last": "Smith",
"email": "john@example.com",
"language": "en",
"roles": { "1c": 1 }
}'
{
"id": "def34",
"first": "John",
"last": "Smith",
"email": "john@example.com",
"language": "en",
"roles": { "1c": 1 },
"tags": [],
"archived": 0,
"district_id": "xyz99",
"created_at": 1709942400000
}
PATCH /api/people/:id
curl -X PATCH https://app.credentialsportal.com/api/people/def34 \
-H "Authorization: Bearer ck_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"roles": { "1b": 1, "1c": 1 },
"tags": ["1a"]
}'
DELETE /api/people/:id
POST /api/people/:id/invite
curl -X POST https://app.credentialsportal.com/api/people/def34/invite \
-H "Authorization: Bearer ck_your_api_key"
{ "ok": true }
GET /api/people/:id/uploads
POST /api/people/:id/uploads
| Field | Description |
|---|---|
file | The file to upload |
name | Display name for the file |
DELETE /api/people/:id/uploads/:uploadId