v3

latestOpenAPI 3.1.02026-08-01389986.6 KB

Record

Get records

Returns records from a collection by ID or metadata filter.

post/api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/get

tenantstring required

Tenant UUID

databasestring required

Database name

collection_idstring required

Collection UUID

{"stackTrail":"components:schemas:GetRequestPayload:allOf:properties:where","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:GetRequestPayload:allOf:properties:where_document","oasType":"schema","type":"unknown"}

idsstring[] nullable

includeInclude[]

limitinteger nullable

offsetinteger nullable

Records retrieved from the collection

documentsstring[] nullable

idsstring[] required

includeInclude[] required

List of fields that were included in this response.

metadatasHashMap[] nullable

urisstring[] nullable