API: entities

Note

Generated from contracts/openapi.json — do not edit by hand. Interactive reference with schemas: /reference.

GET /api/v1/entities

List Entity Types

GET /api/v1/entities/{name}

List Records

List entity records — paginated, sortable, filterable (SPEC-014 §3.2.1).

Any query param that is not a control param (limit/offset/sort/ include_meta) is read as a column filter: col (equals), col_like (ILIKE), col_from/col_to (range). Large JSON/text columns are truncated to a preview stub; ?include_meta=true adds the runtime schema.

Parameter	In	Required	Type
name	path	yes	string
limit	query	no	integer
offset	query	no	integer
sort	query	no	object
include_meta	query	no	boolean
include_deleted	query	no	boolean

POST /api/v1/entities/{name}

Create Record

Parameter	In	Required	Type
name	path	yes	string

POST /api/v1/entities/{name}/bulk-delete

Bulk Delete

Delete many rows — PROD rows without approval are blocked (SPEC-014 §3.2.7).

Parameter	In	Required	Type
name	path	yes	string
x-prod-approval	header	no	object

POST /api/v1/entities/{name}/bulk-export

Bulk Export

Export selected rows as a downloadable JSON file (SPEC-014 §3.2.8).

Parameter	In	Required	Type
name	path	yes	string

GET /api/v1/entities/{name}/count

Count Records

Row count for an entity, cached in-process for 30s (SPEC-014 §3.2.4).

Parameter	In	Required	Type
name	path	yes	string

DELETE /api/v1/entities/{name}/{guid}

Delete Record

Delete a row — soft (deleted_at) for soft-deletable entities (SPEC-014 §3.2.6).

Parameter	In	Required	Type
name	path	yes	string
guid	path	yes	integer
x-prod-approval	header	no	object

GET /api/v1/entities/{name}/{guid}

Read Record

Read one full row + runtime schema for the row drawer (SPEC-014 §3.2.2).

Parameter	In	Required	Type
name	path	yes	string
guid	path	yes	integer

PATCH /api/v1/entities/{name}/{guid}

Update Record

Partial update — PROD-guarded and audit-logged (SPEC-014 §3.2.5).

Parameter	In	Required	Type
name	path	yes	string
guid	path	yes	integer
x-prod-approval	header	no	object

GET /api/v1/entities/{name}/{guid}/audit

Read Audit

Audit trail for one row, projected from lifecycle_log (SPEC-014 §3.2.9).

Latest first. A multi-field edit is expanded into one event per field.

Parameter	In	Required	Type
name	path	yes	string
guid	path	yes	integer
limit	query	no	integer

GET /api/v1/entities/{name}/{guid}/field/{field}

Read Field

Read one field’s full, untruncated value — lazy JSON load (SPEC-014 §3.2.3).

Parameter	In	Required	Type
name	path	yes	string
guid	path	yes	integer
field	path	yes	string

POST /api/v1/entities/{name}/{guid}/restore

Restore Record

Restore a soft-deleted row — clears deleted_at (SPEC-014 §3.2.6a).

Parameter	In	Required	Type
name	path	yes	string
guid	path	yes	integer
x-prod-approval	header	no	object