List a register's records
GET/v1/registers/:register_id/records
The register's current state, one row per record, oldest-updated first. A merge bumps a record's updated_at, so an incremental pull with updated_since sees updated records again: delivery is at-least-once, deduplicate by id and keep the highest version. ?format=csv (or Accept: text/csv) streams every matching record as CSV instead — unpaginated by contract, so limit/after together with it are a 400. A csv register answers with an empty page: its rows are not records yet. 404 for a register this key cannot see. Requires the registers:read scope.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
One page of records as JSON (default) — or, when ?format=csv or Accept: text/csv asks for it, every matching record as a single CSV download, unpaginated.
An unrecognised query parameter (code: unknown_parameter), or one carrying a value this endpoint will not accept (code: invalid_parameter).
Missing, malformed, unknown, revoked, or expired key — one body for all of them (code: unauthorized), with WWW-Authenticate: Bearer realm="hop".
The key lacks the scope (code: insufficient_scope), named in WWW-Authenticate: Bearer error="insufficient_scope", scope="…".
No such register — nonexistent, or another organisation's you have no records in.
Over a bucket. Obey Retry-After (seconds); RateLimit-* fields are informational.
Response Headers
Requests allowed in the current window. Informational.
Requests left in the current window. Informational.
Seconds until the window resets. Informational.
Seconds to wait before retrying. The binding contract.