Meta Pixel
RubikChat
RubikChat
Get Started Free

No credit card required · 14-day free trial

CRM API Overview

Read and manage your RubikChat CRM from your own applications: contacts, companies, deals, custom objects, their fields and the links between them.

Introduction

The RubikChat CRM API gives you access to the same data you see in the CRM of your RubikChat dashboard. With it you can:

  • Create, read, update, delete and search records (contacts, companies, deals and custom objects).
  • Create and read many records at once with batch endpoints.
  • Manage the properties (fields) of every object type.
  • Create your own custom objects with the schemas endpoints.
  • Link records to each other with associations, for example a contact to its company.

One Standard API

Every object (contacts, companies, deals and your custom objects) uses the same paths, request bodies and reply formats, so code written for one object works for all of them.

Note

The CRM API has one version: v3. Every endpoint, including labelled associations, is served under /api/crm/v3.

Base URL

Base URL · text
https://api-proxy-v1.rubikchat.com/api/crm/v3

All requests must be made over HTTPS. Request and reply bodies are JSON.

Object Types

Every record belongs to an object type. In the URL you can address an object type by its id or by its name:

Object type idNameObject
0-1contactsContacts
0-2companiesCompanies
0-3dealsDeals
2-…the name you gave itCustom objects you create with the schemas endpoints

For example, /objects/0-1 and /objects/contacts are the same. Use GET /schemas to list every object type available to your organization, with its id and name.

Tip

The association endpoints that take two object types in the path (for example /associations/0-1/0-2/labels) work most reliably with object type ids. Use ids there.

Records

A record is returned in the same format for every object. Its id is a string, and every property value is a string (or null): numbers are sent as "42", booleans as "true" / "false" and multi-select values as "a;b;c". Dates are ISO 8601 in UTC.

Record · json
{
  "id": "6f1c2a9e-3b4d-4c8a-9f21-7d5e0b8a1c34",
  "properties": {
    "firstname": "Ali",
    "lastname": "Khan",
    "email": "[email protected]",
    "phone": "+923001234567"
  },
  "createdAt": "2026-11-12T10:00:00.000Z",
  "updatedAt": "2026-11-12T10:00:00.000Z",
  "archived": false
}

Lists and search results wrap records in { "total", "results": [...] }. Batch endpoints reply with { "status": "COMPLETE", "results": [...], "startedAt", "completedAt" }. Deletes reply with 204 No Content.

Quick Start

Step 1 — Get an access token

Call the Login API and keep the returned token. See Authentication.

Step 2 — Find your organization slug

Every request names the organization it works on in the X-Organization-Slug header.

Step 3 — Create a contact

Example Request (cURL) · bash
curl --location --request POST 'https://api-proxy-v1.rubikchat.com/api/crm/v3/objects/contacts' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Organization-Slug: your-organization-slug' \
  --header 'Content-Type: application/json' \
  --data '{
  "properties": {
    "firstname": "Ali",
    "lastname": "Khan",
    "email": "[email protected]"
  }
}'

Step 4 — List your contacts

Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/objects/contacts?limit=10' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'X-Organization-Slug: your-organization-slug' \
  --header 'Accept: application/json'

API Reference

PageWhat it covers
AuthenticationAccess token and organization header.
ObjectsCreate, list, read, update and delete records.
SearchFind records with filters and free text.
BatchCreate, read and archive many records at once.
PropertiesThe fields of each object type.
SchemasObject types and custom objects.
AssociationsLinks between records.
ErrorsError format, categories and limits.