#Timelines
Entity: timeline | Scope: crm | Base path: /v1/timelines
Legacy entity (UPPER_CASE field names) — field names are automatically converted to camelCase.
#Operations
| Method | Path | Description | Bitrix24 Method |
|---|---|---|---|
GET |
/v1/timelines |
List all (with filter, sort, pagination) | crm.timeline.comment.list |
GET |
/v1/timelines/:id |
Get by ID | crm.timeline.comment.get |
POST |
/v1/timelines |
Create new | crm.timeline.comment.add |
PATCH |
/v1/timelines/:id |
Update by ID | crm.timeline.comment.update |
DELETE |
/v1/timelines/:id |
Delete by ID | crm.timeline.comment.delete |
GET |
/v1/timelines/fields |
Get available fields | crm.timeline.comment.fields |
#Fields
| API Name | Bitrix24 Name | Type | Readonly | Description |
|---|---|---|---|---|
id |
ID |
number | yes | Идентификатор записи |
entityType |
ENTITY_TYPE |
string | ||
entityId |
ENTITY_ID |
number | ||
comment |
COMMENT |
string | ||
authorId |
AUTHOR_ID |
number | ||
createdAt |
CREATED |
datetime | yes | Дата создания |
#Examples
#List
curl -X GET '/v1/timelines?limit=10' \
-H 'X-Api-Key: YOUR_KEY'
#Get by ID
curl -X GET '/v1/timelines/123' \
-H 'X-Api-Key: YOUR_KEY'
#Create
curl -X POST '/v1/timelines' \
-H 'X-Api-Key: YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"entityType":"value","entityId":1,"comment":"value"}'
#Update
curl -X PATCH '/v1/timelines/123' \
-H 'X-Api-Key: YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"title":"updated"}'
#Delete
curl -X DELETE '/v1/timelines/123' \
-H 'X-Api-Key: YOUR_KEY'
#Batch
curl -X POST '/v1/batch' \
-H 'X-Api-Key: YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"calls":[{"entity":"timelines","action":"list","params":{"limit":5}}]}'