Collections

GET /api/served/collections/{collection}/records returns the records of one collection to your server. It takes an API key with the read_collections scope, minted for an API that names the collection.

Create the API on Schedules with New API: pick the collections and the fields of each that a key may read. Name the fields: a key reads only those, and records that leave under a key cannot be unsent. The loop the key is minted on must declare api delivery and every collection the API serves.

It answers 200 with the collection, its items and a next_cursor. Each item has a record_id, its data (the API’s fields of the record, and no others), created_ts and updated_ts. fields lists the fields served; it is absent when the API serves every field of the collection. Send cursor with the last next_cursor for the next page, and limit for the page size; no next_cursor means the end.

A key that may not read the collection answers 403 with a sentence that says why and what to change: a revoked key, a key without read_collections, or an API that does not name this collection (it names the collections the key does reach). A key on a loop with no published version answers 404.