Skip to main content
GET
/
crm
/
objects
List CRM objects
curl --request GET \
  --url https://http.us.breakcold.com/api/v1/crm/objects \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "slug": "<string>",
      "nameSingular": "<string>",
      "namePlural": "<string>",
      "isSystem": true,
      "isActive": true,
      "order": 123,
      "createdAt": 123,
      "updatedAt": 123,
      "name": "<string>",
      "icon": "<string>",
      "color": "<string>"
    }
  ]
}

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

workspaceId
string
required
Minimum string length: 6

Response

Success

objects
object[]
required