Skip to main content
GET
List records

Authorizations

Authorization
string
header
required

Breakcold public API key, for example Bearer bc_live_....

Headers

X-Breakcold-Organization-Id
string

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

limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string
workspaceId
string
Minimum string length: 6
objectTypeId
string
Minimum string length: 6
objectTypeSlug
string
viewId
string
Minimum string length: 6
archived
boolean
default:false

Search text. By default this matches the record display name only; set searchScope=all to also search indexed text-like field values.

searchScope
enum<string>
default:display

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.

Available options:
display,
all

Response

Success

data
object[]
required
pagination
object
required