Skip to main content
GET
/
crm
/
objects
/
{objectTypeId}
/
fields
List CRM fields
curl --request GET \
  --url https://rest.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://rest.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://rest.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://rest.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://rest.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://rest.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://rest.breakcold.com/api/v1/crm/objects/{objectTypeId}/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "fields": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "objectTypeId": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "fieldType": "<string>",
      "isSystem": true,
      "isRequired": true,
      "isHidden": true,
      "isMultiple": true,
      "isPrimary": true,
      "order": 123,
      "createdAt": 123,
      "updatedAt": 123,
      "description": "<string>",
      "isReadOnly": true,
      "showInCreateModal": true,
      "defaultValue": "<unknown>",
      "validation": {},
      "targetObjectTypeId": "<string>",
      "relationDefinitionId": "<string>",
      "notifyOnAssign": true,
      "defaultValueTemplate": "<string>",
      "isComputed": true,
      "computeExpression": "<string>",
      "isIdentifier": true
    }
  ]
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}

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.

Path Parameters

objectTypeId
string
required

Response

Success

fields
object[]
required