Skip to content

GET /api/v1/entities/{name}

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

List Records

List entity records — paginated, sortable, filterable.

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.

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/entities/<name>" \
-H "Authorization: Bearer <token>"

The contract carries no example for this response; schema: EntityListResponse. Field-level shape: interactive explorer.

EntityListResponse — Successful Response

FieldTypeDescription
itemsarray of object
limitinteger
metaEntityMeta | null (opt.)
offsetinteger
totalinteger
ParameterInRequiredTypeDefaultConstraintsDescription
namepathyesstring——
limitquerynointeger50min 1; max 500
offsetquerynointeger0min 0
sortquerynostring | null——
include_metaquerynobooleanfalse—
include_deletedquerynobooleanfalse—
CodeMeaningBody
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.