:read scope — see Authentication for the full scope list.
Every request only ever returns records that belong to your own organisation. Requesting a record
that exists but belongs to someone else’s organisation returns the same
not_found you’d get for
a record that doesn’t exist at all.Collections
The tenant collection returns contact details only — name, email, phone, and status. It does not
expose financial, income, credit, or identity information, and there is no scoring or screening
endpoint anywhere in the API.
The document collection returns metadata only (name, type, size, and which record it belongs to).
File contents are not available through the API.
Two ways to read a collection
List a collection, one page at a time:Pagination
Lists use cursor-based pagination, not page numbers. Every response includes:nextCursor— an opaque token. Pass it as thecursorquery parameter to fetch the next page.nullon the last page.hasMore—trueif there’s a next page,falseon the last one.
Filtering
Each collection accepts a specific set of filters as query parameters (see the table above). Anything not listed for that collection is rejected rather than silently ignored.cursor and limit alongside any filter to page through a filtered result set.
Getting a single record
Exact fields
The exact field list for every collection is published in the API contract at/api/v1/openapi.json, and stays in sync automatically with what’s live. Use it to confirm a field name or generate a client rather than relying on this page for the complete list.
Next steps
Suggesting Changes
Propose a new record or an update — a person approves it before anything changes.
Errors & Limits
The error format, every error code, and rate limits.