Read parent context and sub-record progress
Requires record read access. Reads up to 200 active record IDs in this database. Returns their active parent, direct-child count, and completion across all active children or descendant leaves, independently of view filters.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/databases/string/sub-records/summaries" \ -H "Content-Type: application/json" \ -d '{ "recordIds": [] }'{ "data": [ { "recordId": "0470cfd4-dcf3-4d8c-ac28-58c6deeff25f", "parent": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string" }, "childCount": 0, "progress": { "completed": 0, "total": 0, "mode": "children" } } ]}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Configure sub-records and progress
Requires database write access. Creates or adopts an optional reciprocal Parent(one)/Sub-records(many) relation in a native database and configures checkbox/status/select completion. Disabling preserves links and hierarchy invariants. Send an Idempotency-Key for retryable mutations.
Read a root or child collection with ancestor filter context
Requires record read access. parentId null pages roots; a record ID pages direct children. Returns up to 100 records with hasMore and a revision-bound cursor. A saved view applies its visibility, filters and sibling sorting; matching descendants retain ancestors as context. Restart at page one after a stale cursor. The bulk children relation is omitted.