Black Friday Black Friday: the new LetsBot bundles save up to 60% — until 30 November only. See the bundles See the bundles
LetsBot Menu
Get Started English Language

Verified Meta Tech Provider UK Registered Company

Language

CRM · API endpoint

GET /api/v1/crm/objects New

List custom objects

The workspace's custom CRM objects (for example Projects or Properties) with their fields: key, label, type, options, whether a field is required, and…

The workspace's custom CRM objects (for example Projects or Properties) with their fields: key, label, type, options, whether a field is required, and whether it is read-only (formula and rollup fields are computed). Available while the workspace uses custom objects (CRM → Custom objects); until then these paths answer 404. Scope: crm.

Example request

curl -G "https://your-workspace.letsbot.net/api/v1/crm/objects" \
  -H "X-Zapier-Api-Key: YOUR_WORKSPACE_API_KEY" \
  -H "Accept: application/json"
const response = await fetch("https://your-workspace.letsbot.net/api/v1/crm/objects", {
  method: "GET",
  headers: {
    "X-Zapier-Api-Key": "YOUR_WORKSPACE_API_KEY",
    "Accept": "application/json",
  },
});

const data = await response.json();
console.log(data);
<?php

$ch = curl_init('https://your-workspace.letsbot.net/api/v1/crm/objects');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-Zapier-Api-Key: YOUR_WORKSPACE_API_KEY',
        'Accept: application/json',
    ],
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($data);
import requests

response = requests.request(
    "GET",
    "https://your-workspace.letsbot.net/api/v1/crm/objects",
    headers={
        "X-Zapier-Api-Key": "YOUR_WORKSPACE_API_KEY",
        "Accept": "application/json",
    },
)

print(response.json())

Responses

Objects200
{
  "success": true,
  "data": [
    {
      "key": "co_projects",
      "label_singular": {
        "ar": "مشروع",
        "en": "Project"
      },
      "label_plural": {
        "ar": "مشاريع",
        "en": "Projects"
      },
      "primary_field": "name",
      "fields": [
        {
          "key": "name",
          "label": "Project name",
          "type": "text",
          "required": true,
          "read_only": false,
          "options": null,
          "settings": {}
        },
        {
          "key": "budget",
          "label": "Budget",
          "type": "currency",
          "required": false,
          "read_only": false,
          "options": null,
          "settings": {
            "currency": "SAR"
          }
        },
        {
          "key": "status",
          "label": "Status",
          "type": "select",
          "required": false,
          "read_only": false,
          "options": [
            {
              "value": "planned",
              "label": "Planned"
            },
            {
              "value": "active",
              "label": "Active"
            }
          ],
          "settings": {}
        },
        {
          "key": "starts_on",
          "label": "Starts",
          "type": "date",
          "required": false,
          "read_only": false,
          "options": null,
          "settings": {}
        },
        {
          "key": "client",
          "label": "Client",
          "type": "relation",
          "required": false,
          "read_only": false,
          "options": null,
          "settings": {
            "target": "contact",
            "many": false
          }
        },
        {
          "key": "partners",
          "label": "Partners",
          "type": "relation",
          "required": false,
          "read_only": false,
          "options": null,
          "settings": {
            "target": "company",
            "many": true
          }
        },
        {
          "key": "units",
          "label": "Units",
          "type": "rollup",
          "required": false,
          "read_only": true,
          "options": null,
          "settings": {
            "relation_object": "co_units",
            "relation_field": "project",
            "function": "count"
          }
        }
      ]
    }
  ]
}

Ready when you are

Try this endpoint on your own number

The API works during the free trial. Create an account, connect your WhatsApp number and copy your key from API → Authentication Data.