Skip to main content
GET
Returns a page of the records of one type that the token owner’s roles let them read. Fields and columns the roles hide are not searchable and answer like a name that does not exist.
Scope crm:read.

Query parameters

string
required
The type: company, person, opportunity or a custom key. A type the roles do not allow answers 404.
string
A filter in the Collabase query language, for example title ~ "AG". The query is confined to the type.
string
Up to three keys as field:asc or field:desc, separated by commas. Not allowed together with ORDER BY in cql.
string
Comma-separated field keys to return as cells. Hidden columns are dropped.
string
The nextCursor of the previous page. A cursor of another query answers 422.
number
default:"20"
1 to 100; more is cut down to 100.

Response

object
required
Last modified on November 13, 2026