Перейти к содержимому

GET /api/v1/entities/{name}

Статус: GA Доступ: по токену контракт API: 0.3.0 · capability 2026-09-03.1 Открыть как Markdown Открыть в Claude Открыть в 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.

Авторизация: нужен Authorization: Bearer <token>

Окно терминала
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/entities/<name>" \
-H "Authorization: Bearer <token>"

В контракте нет примера для этого ответа; схема: EntityListResponse. Поля — в интерактивном обозревателе.

EntityListResponse — Successful Response

ПолеТипОписание
itemsмассив object
limitinteger
metaEntityMeta | null (opt.)
offsetinteger
totalinteger
ПараметрГдеОбязателенТипПо умолчаниюОграниченияОписание
namepathдаstring——
limitqueryнетinteger50min 1; max 500
offsetqueryнетinteger0min 0
sortqueryнетstring | null——
include_metaqueryнетbooleanfalse—
include_deletedqueryнетbooleanfalse—
КодСмыслТело
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Тело любой ошибки — {detail, code?, request_id, doc_url}: request_id — что цитировать, doc_url ведёт в Справочник ошибок.