Skip to main content
GET
/
records
List records
curl --request GET \
  --url https://http.us.breakcold.com/api/v1/records \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "objectTypeId": "<string>",
      "isArchived": true,
      "createdAt": 123,
      "updatedAt": 123,
      "objectTypeSlug": "<string>",
      "displayName": "<string>",
      "fields": {},
      "archivedAt": 123
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Response

Success

data
object[]
required
pagination
object
required