Read records
GET/query
Returns a page of records for one object.
Only the fields the administrator selected for this key are returned, and only rows that pass both their filter and the portal's own sharing rules.
Reading the response
records holds the rows. Each row always carries Id, plus one key per selected
field. A lookup field arrives as three keys: the display value, the same name
with _id for the record it points at, and _obj for that record's object. So a
selected RecordTypeId returns RecordTypeId, RecordTypeId_id and
RecordTypeId_obj.
Moving between pages
You do not get everything at once. The response carries nextUrl and prevUrl —
complete addresses, with your own parameters already carried over. Open nextUrl
to go forward and prevUrl to go back; an empty value means there is nothing in
that direction. On the first page prevUrl is always empty.
Following those links is the intended way to page. Building the address yourself means handling the cursor, which is deliberately opaque and may change form.
Request
Responses
- 200
- 400
- 401
- 403
- 429
A page of records.
The request could not be completed. The error field says what to change —
for example an object that was not named, an External Id field that is not set
up on that object, or a sort field that is not granted or cannot be sorted on.
Not authorised. The Client ID is unknown, the Secret does not match, or the key has been revoked — the response is deliberately the same for all three, so the endpoint cannot be used to work out which.
The object is not available to this key — either the administrator never granted it, or the key's portal user has since lost permission to read it. Both give the same answer on purpose.
Too many requests this hour. The ceiling is set per key and defaults to 500.
Wait, then continue — a Retry-After header is returned alongside.
Response Headers
Seconds to wait before trying again.