Documentation
API Reference
✦✦✦
GET
/api/saintsPaginated browse with optional filters.
Query Parameters
| Param | Type | Description |
|---|---|---|
limit | integer | Records per page (max 200)(default: 20) |
offset | integer | Pagination offset(default: 0) |
letter | string | Filter by starting letter (A–Z) |
tag | string | Filter by category tag (repeatable) |
GET
/api/searchFull-text search with trigram fallback for typo tolerance.
Query Parameters
| Param | Type | Description |
|---|---|---|
q* | string | Search query |
limit | integer | Results per page(default: 20) |
offset | integer | Pagination offset(default: 0) |
GET
/api/saints/{id}Retrieve a single saint record by integer ID.
PATCH
/api/saints/{id}Update a single field on a saint record.
Request Body
| Param | Type | Description |
|---|---|---|
field* | string | Field name to update |
value | any | New value for the field |
reason | string | Optional audit note |
POST
/api/jobs/enqueueEnqueue background jobs for one or more saint records.
Request Body
| Param | Type | Description |
|---|---|---|
job_type* | string | Job type identifier |
saint_ids | integer[] | Specific saint IDs to target (omit to enqueue all) |
GET
/api/jobs/statsReturn counts of pending, running, and completed jobs.
Query Parameters
| Param | Type | Description |
|---|---|---|
job_type | string | Filter stats to a specific job type |
GET
/api/healthLightweight health check. Returns `{ "status": "ok" }`.