List records
List or search records in one workspace and object type.
Search modes:
searchScope=display(default) searches only the record display name. This preserves the original API behavior and is best when you want a precise name lookup.searchScope=allsearches the display name plus indexed text-like field values on the record: text, textarea, email, phone, URL/social fields, location, select, and multiselect labels. It does not search notes, tasks, conversations, relation target names, numbers, dates, booleans, members, or files.
| Token cost | Rate limit |
|---|---|
| 20 tokens | 120 requests/min per route/org |
Authorizations
Breakcold public API key, for example Bearer bc_live_....
Headers
Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token.
Query Parameters
1 <= x <= 100666Search text. By default this matches the record display name only; set searchScope=all to also search indexed text-like field values.
display searches only record display names. all searches display names plus indexed text-like field values: text, textarea, email, phone, URL/social fields, location, select, and multiselect labels.
display, all