Objects
Create, list, read, update and delete records of any object type: contacts, companies, deals and your custom objects. Replace {objectType} with an object type id (0-1) or name (contacts).
Create a record
Creates one record. The reply is the new record with its id.
POST/objects/{objectType}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| properties | object | required | Property names and their values, e.g. { "firstname": "Ali" }. |
| associations | array | optional | Records to link the new record to: [{ to: { id }, types: [{ associationCategory, associationTypeId }] }]. |
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]",
"phone": "+923001234567"
},
"associations": [
{
"to": {
"id": "0c5a7e3b-1f2d-4b6c-a8e9-3d4f5a6b7c8d"
},
"types": [
{
"associationCategory": "SYSTEM_DEFINED",
"associationTypeId": 1
}
]
}
]
}'Status: 201 Created
Example Response · 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
}Note
A property name that does not exist yet on the object type is created as a text property. Create properties with the right type first on the Properties endpoints when you need numbers, dates or options. Find the
associationTypeId values on the Associations page.List records
Lists the records of an object type, newest first.
total is the number of records of that type in your organization.GET/objects/{objectType}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Records per page, up to 1000. Without it, all records are returned. |
| page | integer | optional | Page number, starting at 1. Used with limit. |
Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/objects/contacts?limit=10&page=1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Accept: application/json'Status: 200 OK
Example Response · json
{
"total": 2,
"results": [
{
"id": "b82e4d10-95c7-4f3a-8e6b-2c9d71f0a5e8",
"properties": {
"firstname": "Sara",
"lastname": "Ahmed",
"email": "[email protected]"
},
"createdAt": "2026-11-12T10:05:00.000Z",
"updatedAt": "2026-11-12T10:05:00.000Z",
"archived": false
},
{
"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
}
]
}Read a record
Returns one record with all its properties.
GET/objects/{objectType}/{recordId}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
| recordId | string | required | The id of the record. |
Example Request (cURL) · bash
curl --location --request GET 'https://api-proxy-v1.rubikchat.com/api/crm/v3/objects/contacts/6f1c2a9e-3b4d-4c8a-9f21-7d5e0b8a1c34' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Accept: application/json'Status: 200 OK
Example Response · 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
}Update a record
Changes some properties of a record. The reply is the updated record.
PATCH/objects/{objectType}/{recordId}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
| recordId | string | required | The id of the record. |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| properties | object | required | The properties to change. Properties you leave out keep their value. |
Example Request (cURL) · bash
curl --location --request PATCH 'https://api-proxy-v1.rubikchat.com/api/crm/v3/objects/contacts/6f1c2a9e-3b4d-4c8a-9f21-7d5e0b8a1c34' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Content-Type: application/json' \
--data '{
"properties": {
"phone": "+923009876543"
}
}'Status: 200 OK
Example Response · json
{
"id": "6f1c2a9e-3b4d-4c8a-9f21-7d5e0b8a1c34",
"properties": {
"firstname": "Ali",
"lastname": "Khan",
"email": "[email protected]",
"phone": "+923009876543"
},
"createdAt": "2026-11-12T10:00:00.000Z",
"updatedAt": "2026-11-12T11:30:00.000Z",
"archived": false
}Delete a record
Deletes (archives) a record.
DELETE/objects/{objectType}/{recordId}
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| objectType | string | required | Object type id (0-1 contacts, 0-2 companies, 0-3 deals, 2-… custom objects) or its name, e.g. contacts. |
| recordId | string | required | The id of the record. |
Example Request (cURL) · bash
curl --location --request DELETE 'https://api-proxy-v1.rubikchat.com/api/crm/v3/objects/contacts/6f1c2a9e-3b4d-4c8a-9f21-7d5e0b8a1c34' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'X-Organization-Slug: your-organization-slug' \
--header 'Accept: application/json'Status: 204 No Content
The reply has no body.