# Bitrix24

> Work with your Bitrix24 CRM and tasks: create and update leads, deals, contacts, companies and smart process items, add to-dos and timeline comments, manage tasks, send chat messages, and start workflows when records or tasks are added or changed.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/bitrix24

## Actions

### Add timeline comment

Add a comment to the timeline of a lead, deal, contact, company or smart process item.

**Inputs**

- Record type (`record_type`, text, required): Lead, Deal, Contact, Company or one of your smart processes.
- Record ID (`record_id`, text, required): The record's id, from a list step or an earlier step.
- Comment (`comment`, text, required): The comment's text.

**Outputs**

- `comment_id` (number): The comment's id
- `record_id` (number): The record's id
- `record_type` (number): The record type's id (1 lead, 2 deal, 3 contact, 4 company)

**Example output**

```json
{
  "comment_id": 999,
  "record_id": 410,
  "record_type": 2
}
```

### Complete task

Mark a task as done. If the task needs its creator's review, it waits for review instead.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or an earlier step.

**Outputs**

- `task` (object): The task
- `task_id` (number): The task's id

**Example output**

```json
{
  "task": {
    "changedDate": "2026-11-02T10:06:08+02:00",
    "closedDate": "2026-11-03T12:11:30+02:00",
    "createdBy": "1",
    "createdDate": "2026-11-02T10:06:08+02:00",
    "deadline": "2026-11-09T18:00:00+02:00",
    "description": "Confirm the renewal terms.",
    "groupId": "0",
    "id": "3711",
    "priority": "1",
    "responsibleId": "1",
    "status": "5",
    "title": "Call Acme back"
  },
  "task_id": 3711
}
```

### Create company

Add a company to the CRM with its type, email, phone, website and revenue. Returns the new company.

**Inputs**

- Name (`title`, text, required): The company's name.
- Type (`company_type`, text): What the company is to you, such as Client or Supplier.
- Email (`email`, text): The company's work email.
- Phone (`phone`, text): The company's work phone, with the country code.
- Website (`website`, text): The company's website.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Annual revenue (`revenue`, number): The company's yearly revenue. At least 0.
- Currency (`currency_id`, text): The currency of the amount, such as USD.
- Comment (`comments`, text): Notes kept on the record.
- More fields (`more_fields`, object): Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.

**Outputs**

- `company` (object): The company
- `company_id` (number): The new company's id

**Example output**

```json
{
  "company": {
    "ASSIGNED_BY_ID": "1",
    "COMMENTS": "Key account.",
    "COMPANY_TYPE": "CUSTOMER",
    "CURRENCY_ID": "USD",
    "DATE_CREATE": "2026-11-02T10:06:08+02:00",
    "DATE_MODIFY": "2026-11-02T10:06:08+02:00",
    "EMAIL": [
      {
        "ID": "2001",
        "TYPE_ID": "EMAIL",
        "VALUE": "hello@acme.example",
        "VALUE_TYPE": "WORK"
      }
    ],
    "ID": "9",
    "PHONE": [
      {
        "ID": "2002",
        "TYPE_ID": "PHONE",
        "VALUE": "+15555550100",
        "VALUE_TYPE": "WORK"
      }
    ],
    "REVENUE": "3000000.00",
    "TITLE": "Acme Inc",
    "WEB": [
      {
        "ID": "2003",
        "TYPE_ID": "WEB",
        "VALUE": "acme.example",
        "VALUE_TYPE": "WORK"
      }
    ]
  },
  "company_id": 9
}
```

### Create contact

Add a contact to the CRM with their name, email, phone, job title and company. Returns the new contact.

**Inputs**

- First name (`first_name`, text): Their first name. A first or last name is needed.
- Last name (`last_name`, text): Their last name. A first or last name is needed.
- Email (`email`, text): Their work email.
- Phone (`phone`, text): Their work phone, with the country code.
- Position (`position`, text): Their job title.
- Company (`company_id`, text): The company it belongs to.
- Source (`source_id`, text): Where it came from, such as Website.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Birthday (`birthdate`, date): Their date of birth.
- Comment (`comments`, text): Notes kept on the record.
- More fields (`more_fields`, object): Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.

**Outputs**

- `contact` (object): The contact
- `contact_id` (number): The new contact's id

**Example output**

```json
{
  "contact": {
    "ASSIGNED_BY_ID": "1",
    "COMMENTS": "Met at the expo.",
    "COMPANY_ID": "9",
    "DATE_CREATE": "2026-11-02T10:06:08+02:00",
    "DATE_MODIFY": "2026-11-02T10:06:08+02:00",
    "EMAIL": [
      {
        "ID": "2001",
        "TYPE_ID": "EMAIL",
        "VALUE": "jo@example.com",
        "VALUE_TYPE": "WORK"
      }
    ],
    "ID": "84",
    "LAST_NAME": "Bloggs",
    "NAME": "Jo",
    "PHONE": [
      {
        "ID": "2002",
        "TYPE_ID": "PHONE",
        "VALUE": "+15555550100",
        "VALUE_TYPE": "WORK"
      }
    ],
    "POST": "Head of Operations",
    "SOURCE_ID": "WEB"
  },
  "contact_id": 84
}
```

### Create deal

Add a deal to a pipeline at a stage, with its amount, contacts, company and close date. Returns the new deal.

**Inputs**

- Title (`title`, text, required): The deal's name.
- Pipeline (`category_id`, text): The deal pipeline. Leave empty for the main one, or let the stage decide.
- Stage (`stage_id`, text): The deal's stage. Each stage belongs to one pipeline.
- Amount (`opportunity`, number): The deal's value. At least 0.
- Currency (`currency_id`, text): The currency of the amount, such as USD.
- Contacts (`contact_ids`, list): The contacts it involves.
- Company (`company_id`, text): The company it belongs to.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Start date (`begin_date`, date): When the deal starts.
- Expected close date (`close_date`, date): When the deal is expected to close.
- Source (`source_id`, text): Where it came from, such as Website.
- Comment (`comments`, text): Notes kept on the record.
- More fields (`more_fields`, object): Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.

**Outputs**

- `deal` (object): The deal
- `deal_id` (number): The new deal's id

**Example output**

```json
{
  "deal": {
    "ASSIGNED_BY_ID": "1",
    "BEGINDATE": "2026-11-02T02:00:00+02:00",
    "CATEGORY_ID": "0",
    "CLOSED": "N",
    "CLOSEDATE": "2026-11-30T02:00:00+02:00",
    "COMMENTS": "Renewal for next year.",
    "COMPANY_ID": "9",
    "CONTACT_ID": "84",
    "CURRENCY_ID": "EUR",
    "DATE_CREATE": "2026-11-02T14:29:00+02:00",
    "DATE_MODIFY": "2026-11-02T14:29:00+02:00",
    "ID": "410",
    "MOVED_TIME": "2026-11-02T14:29:00+02:00",
    "OPPORTUNITY": "1000000.00",
    "SOURCE_ID": "CALLBACK",
    "STAGE_ID": "PREPARATION",
    "STAGE_SEMANTIC_ID": "P",
    "TITLE": "Acme renewal"
  },
  "deal_id": 410
}
```

### Create lead

Add a lead to the Bitrix24 CRM with the person's name, email, phone, company, status and source. Returns the new lead.

**Inputs**

- Title (`title`, text, required): The lead's name in the CRM.
- First name (`first_name`, text): The person's first name.
- Last name (`last_name`, text): The person's last name.
- Email (`email`, text): The person's work email.
- Phone (`phone`, text): The person's work phone, with the country code.
- Company name (`company_title`, text): The name of their company, as text.
- Status (`status_id`, text): The lead's status, such as New.
- Source (`source_id`, text): Where it came from, such as Website.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Amount (`opportunity`, number): The lead's expected value. At least 0.
- Currency (`currency_id`, text): The currency of the amount, such as USD.
- Comment (`comments`, text): Notes kept on the record.
- More fields (`more_fields`, object): Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.

**Outputs**

- `lead` (object): The lead
- `lead_id` (number): The new lead's id

**Example output**

```json
{
  "lead": {
    "ASSIGNED_BY_ID": "1",
    "COMMENTS": "Asked for a demo.",
    "COMPANY_TITLE": "Acme Inc",
    "CURRENCY_ID": "USD",
    "DATE_CREATE": "2026-11-02T10:06:08+02:00",
    "DATE_MODIFY": "2026-11-02T10:06:08+02:00",
    "EMAIL": [
      {
        "ID": "2001",
        "TYPE_ID": "EMAIL",
        "VALUE": "jo@example.com",
        "VALUE_TYPE": "WORK"
      }
    ],
    "ID": "3465",
    "LAST_NAME": "Bloggs",
    "NAME": "Jo",
    "OPPORTUNITY": "12500.00",
    "PHONE": [
      {
        "ID": "2002",
        "TYPE_ID": "PHONE",
        "VALUE": "+15555550100",
        "VALUE_TYPE": "WORK"
      }
    ],
    "SOURCE_ID": "WEB",
    "STATUS_ID": "NEW",
    "TITLE": "Website enquiry"
  },
  "lead_id": 3465
}
```

### Create smart process item

Add an item to one of your smart processes (custom CRM objects), with its stage, responsible person, company and contacts. Returns the new item.

**Inputs**

- Smart process (`smart_process`, text, required): The smart process (custom CRM object), picked by name or given by its type id.
- Title (`title`, text, required): The item's name.
- Pipeline ID (`category_id`, text): The id of the smart process's pipeline, if it has more than one.
- Stage (`stage_id`, text): The stage's code, such as DT1046_9:NEW, from the item list. Leave empty for the first stage.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Company (`company_id`, text): The company it belongs to.
- Contacts (`contact_ids`, list): The contacts it involves.
- Amount (`opportunity`, number): The item's value. At least 0.
- Currency (`currency_id`, text): The currency of the amount, such as USD.
- Close date (`close_date`, date): When the item is expected to close.
- More fields (`more_fields`, object): Any other fields, by the codes smart processes use, such as {"ufCrm5_1721244482250": "Gold"}.

**Outputs**

- `item` (object): The item
- `item_id` (number): The new item's id

**Example output**

```json
{
  "item": {
    "assignedById": 6,
    "categoryId": 9,
    "companyId": 5,
    "contactIds": [
      4
    ],
    "createdTime": "2026-11-02T14:00:14+02:00",
    "currencyId": "EUR",
    "id": 342,
    "opportunity": 999.99,
    "stageId": "DT1046_9:NEW",
    "title": "Supplier onboarding",
    "updatedTime": "2026-11-02T14:00:14+02:00"
  },
  "item_id": 342
}
```

### Create task

Create a task with an assignee, deadline and priority, in a project if you like, linked to CRM records if you like. Returns the new task.

**Inputs**

- Title (`title`, text, required): What the task is.
- Description (`description`, text): What needs doing.
- Assignee (`responsible_id`, text): Who does it. Leave empty to assign it to the person who made the webhook.
- Deadline (`deadline`, date and time): When it is due.
- Priority (`priority`, text): How important the task is. Bitrix24 defaults to Medium. One of: `0` (Low), `1` (Medium), `2` (High).
- Project ID (`group_id`, text): The id of the workgroup or project the task belongs to, from its address in Bitrix24.
- Participants (`accomplice_ids`, list): People who help with the task.
- Observers (`auditor_ids`, list): People who follow the task.
- CRM records (`crm_links`, text): CRM records to link, separated by commas: D_12 for deal 12, L_5 for a lead, C_7 for a contact, CO_3 for a company.

**Outputs**

- `task` (object): The task
- `task_id` (number): The task's id

**Example output**

```json
{
  "task": {
    "changedDate": "2026-11-02T10:06:08+02:00",
    "closedDate": "",
    "createdBy": "1",
    "createdDate": "2026-11-02T10:06:08+02:00",
    "deadline": "2026-11-09T18:00:00+02:00",
    "description": "Confirm the renewal terms.",
    "groupId": "0",
    "id": "3711",
    "priority": "1",
    "responsibleId": "1",
    "status": "2",
    "title": "Call Acme back"
  },
  "task_id": 3711
}
```

### Create to-do

Add a to-do with a deadline to a lead, deal, contact, company or smart process item, shown in its timeline, with an optional reminder.

**Inputs**

- Record type (`record_type`, text, required): Lead, Deal, Contact, Company or one of your smart processes.
- Record ID (`record_id`, text, required): The record's id, from a list step or an earlier step.
- Deadline (`deadline`, date and time, required): When it is due.
- Title (`title`, text): What the to-do is.
- Description (`description`, text): More detail.
- Responsible person (`responsible_id`, text): The Bitrix24 user responsible for it.
- Remind minutes before (`remind_minutes_before`, number): Send a reminder this many minutes before the deadline. At least 0.

**Outputs**

- `activity_id` (number): The to-do's activity id
- `deadline` (text): When it is due
- `record_id` (number): The record's id
- `record_type` (number): The record type's id (1 lead, 2 deal, 3 contact, 4 company)

**Example output**

```json
{
  "activity_id": 999,
  "deadline": "2026-11-09T15:00:00+00:00",
  "record_id": 410,
  "record_type": 2
}
```

### Delete CRM record

Delete a lead, deal, contact, company or smart process item for good.

**Inputs**

- Record type (`record_type`, text, required): Lead, Deal, Contact, Company or one of your smart processes.
- Record ID (`record_id`, text, required): The record's id, from a list step or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `record_id` (number): The record's id
- `record_type` (number): The record type's id (1 lead, 2 deal, 3 contact, 4 company)

**Example output**

```json
{
  "deleted": true,
  "record_id": 410,
  "record_type": 2
}
```

### Delete task

Delete a task for good.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `task_id` (number): The deleted task's id

**Example output**

```json
{
  "deleted": true,
  "task_id": 3711
}
```

### Get deal

Get one deal with its pipeline, stage, amount, contact and company.

**Inputs**

- Deal ID (`deal_id`, text, required): The deal's id, from 'List deals' or an earlier step.

**Outputs**

- `deal` (object): The deal

**Example output**

```json
{
  "deal": {
    "ASSIGNED_BY_ID": "1",
    "BEGINDATE": "2026-11-02T02:00:00+02:00",
    "CATEGORY_ID": "0",
    "CLOSED": "N",
    "CLOSEDATE": "2026-11-30T02:00:00+02:00",
    "COMMENTS": "Renewal for next year.",
    "COMPANY_ID": "9",
    "CONTACT_ID": "84",
    "CURRENCY_ID": "EUR",
    "DATE_CREATE": "2026-11-02T14:29:00+02:00",
    "DATE_MODIFY": "2026-11-02T14:29:00+02:00",
    "ID": "410",
    "MOVED_TIME": "2026-11-02T14:29:00+02:00",
    "OPPORTUNITY": "1000000.00",
    "SOURCE_ID": "CALLBACK",
    "STAGE_ID": "PREPARATION",
    "STAGE_SEMANTIC_ID": "P",
    "TITLE": "Acme renewal"
  }
}
```

### Get lead

Get one lead with all its fields, emails and phone numbers.

**Inputs**

- Lead ID (`lead_id`, text, required): The lead's id, from 'List leads' or an earlier step.

**Outputs**

- `lead` (object): The lead

**Example output**

```json
{
  "lead": {
    "ASSIGNED_BY_ID": "1",
    "COMMENTS": "Asked for a demo.",
    "COMPANY_TITLE": "Acme Inc",
    "CURRENCY_ID": "USD",
    "DATE_CREATE": "2026-11-02T10:06:08+02:00",
    "DATE_MODIFY": "2026-11-02T10:06:08+02:00",
    "EMAIL": [
      {
        "ID": "2001",
        "TYPE_ID": "EMAIL",
        "VALUE": "jo@example.com",
        "VALUE_TYPE": "WORK"
      }
    ],
    "ID": "3465",
    "LAST_NAME": "Bloggs",
    "NAME": "Jo",
    "OPPORTUNITY": "12500.00",
    "PHONE": [
      {
        "ID": "2002",
        "TYPE_ID": "PHONE",
        "VALUE": "+15555550100",
        "VALUE_TYPE": "WORK"
      }
    ],
    "SOURCE_ID": "WEB",
    "STATUS_ID": "NEW",
    "TITLE": "Website enquiry"
  }
}
```

### Get task

Get one task with its status, assignee, deadline and dates.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or an earlier step.

**Outputs**

- `task` (object): The task

**Example output**

```json
{
  "task": {
    "changedDate": "2026-11-02T10:06:08+02:00",
    "closedDate": "",
    "createdBy": "1",
    "createdDate": "2026-11-02T10:06:08+02:00",
    "deadline": "2026-11-09T18:00:00+02:00",
    "description": "Confirm the renewal terms.",
    "groupId": "0",
    "id": "3711",
    "priority": "1",
    "responsibleId": "1",
    "status": "2",
    "title": "Call Acme back"
  }
}
```

### List contacts

Find contacts, newest first, by exact email or phone, last name, company, responsible person or creation date. Gets one page of 50; to see more, run it again with the next page it gives.

**Inputs**

- Email (`email`, text): Only contacts with exactly this email.
- Phone (`phone`, text): Only contacts with exactly this phone number.
- Last name contains (`search`, text): Only contacts whose last name contains this.
- Company (`company_id`, text): The company it belongs to.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Created on or after (`created_after`, date): Only those created on or after this date.
- Start at (`start`, number): Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before. At least 0.

**Outputs**

- `contacts` (list): The contacts
- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is another page
- `next_start` (number): The Start at value for the next page; 0 when this is the last
- `total` (number): How many match, on every page

**Example output**

```json
{
  "contacts": [
    {
      "ASSIGNED_BY_ID": "1",
      "COMMENTS": "Met at the expo.",
      "COMPANY_ID": "9",
      "DATE_CREATE": "2026-11-02T10:06:08+02:00",
      "DATE_MODIFY": "2026-11-02T10:06:08+02:00",
      "EMAIL": [
        {
          "ID": "2001",
          "TYPE_ID": "EMAIL",
          "VALUE": "jo@example.com",
          "VALUE_TYPE": "WORK"
        }
      ],
      "ID": "84",
      "LAST_NAME": "Bloggs",
      "NAME": "Jo",
      "PHONE": [
        {
          "ID": "2002",
          "TYPE_ID": "PHONE",
          "VALUE": "+15555550100",
          "VALUE_TYPE": "WORK"
        }
      ],
      "POST": "Head of Operations",
      "SOURCE_ID": "WEB"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_start": 0,
  "total": 1
}
```

### List deals

List deals, newest first, filtered by pipeline, stage, responsible person, company, contact, title or creation date. Gets one page of 50; to see more, run it again with the next page it gives.

**Inputs**

- Pipeline (`category_id`, text): The deal pipeline. Leave empty for the main one, or let the stage decide.
- Stage (`stage_id`, text): The deal's stage. Each stage belongs to one pipeline.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Company (`company_id`, text): The company it belongs to.
- Contact (`contact_id`, text): Only deals with this contact.
- Title contains (`search`, text): Only those whose title contains this.
- Created on or after (`created_after`, date): Only those created on or after this date.
- Start at (`start`, number): Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `deals` (list): The deals
- `has_more` (true/false): Whether there is another page
- `next_start` (number): The Start at value for the next page; 0 when this is the last
- `total` (number): How many match, on every page

**Example output**

```json
{
  "count": 1,
  "deals": [
    {
      "ASSIGNED_BY_ID": "1",
      "BEGINDATE": "2026-11-02T02:00:00+02:00",
      "CATEGORY_ID": "0",
      "CLOSED": "N",
      "CLOSEDATE": "2026-11-30T02:00:00+02:00",
      "COMMENTS": "Renewal for next year.",
      "COMPANY_ID": "9",
      "CONTACT_ID": "84",
      "CURRENCY_ID": "EUR",
      "DATE_CREATE": "2026-11-02T14:29:00+02:00",
      "DATE_MODIFY": "2026-11-02T14:29:00+02:00",
      "ID": "410",
      "MOVED_TIME": "2026-11-02T14:29:00+02:00",
      "OPPORTUNITY": "1000000.00",
      "SOURCE_ID": "CALLBACK",
      "STAGE_ID": "PREPARATION",
      "STAGE_SEMANTIC_ID": "P",
      "TITLE": "Acme renewal"
    }
  ],
  "has_more": false,
  "next_start": 0,
  "total": 1
}
```

### List leads

List leads, newest first, filtered by status, responsible person, title, email or creation date. Gets one page of 50; to see more, run it again with the next page it gives.

**Inputs**

- Status (`status_id`, text): The lead's status, such as New.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Title contains (`search`, text): Only those whose title contains this.
- Email (`email`, text): Only leads with exactly this email.
- Created on or after (`created_after`, date): Only those created on or after this date.
- Start at (`start`, number): Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is another page
- `leads` (list): The leads
- `next_start` (number): The Start at value for the next page; 0 when this is the last
- `total` (number): How many match, on every page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "leads": [
    {
      "ASSIGNED_BY_ID": "1",
      "COMMENTS": "Asked for a demo.",
      "COMPANY_TITLE": "Acme Inc",
      "CURRENCY_ID": "USD",
      "DATE_CREATE": "2026-11-02T10:06:08+02:00",
      "DATE_MODIFY": "2026-11-02T10:06:08+02:00",
      "EMAIL": [
        {
          "ID": "2001",
          "TYPE_ID": "EMAIL",
          "VALUE": "jo@example.com",
          "VALUE_TYPE": "WORK"
        }
      ],
      "ID": "3465",
      "LAST_NAME": "Bloggs",
      "NAME": "Jo",
      "OPPORTUNITY": "12500.00",
      "PHONE": [
        {
          "ID": "2002",
          "TYPE_ID": "PHONE",
          "VALUE": "+15555550100",
          "VALUE_TYPE": "WORK"
        }
      ],
      "SOURCE_ID": "WEB",
      "STATUS_ID": "NEW",
      "TITLE": "Website enquiry"
    }
  ],
  "next_start": 0,
  "total": 1
}
```

### List smart process items

List a smart process's items, newest first, filtered by stage, responsible person, title or creation date. Gets one page of 50; to see more, run it again with the next page it gives.

**Inputs**

- Smart process (`smart_process`, text, required): The smart process (custom CRM object), picked by name or given by its type id.
- Stage (`stage_id`, text): Only items at this stage, by its code.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Title contains (`search`, text): Only those whose title contains this.
- Created on or after (`created_after`, date): Only those created on or after this date.
- Start at (`start`, number): Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is another page
- `items` (list): The items
- `next_start` (number): The Start at value for the next page; 0 when this is the last
- `total` (number): How many match, on every page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "assignedById": 6,
      "categoryId": 9,
      "companyId": 5,
      "contactIds": [
        4
      ],
      "createdTime": "2026-11-02T14:00:14+02:00",
      "currencyId": "EUR",
      "id": 342,
      "opportunity": 999.99,
      "stageId": "DT1046_9:NEW",
      "title": "Supplier onboarding",
      "updatedTime": "2026-11-02T14:00:14+02:00"
    }
  ],
  "next_start": 0,
  "total": 1
}
```

### List tasks

List tasks, newest first, filtered by assignee, status, project, title or creation date. Gets one page of 50; to see more, run it again with the next page it gives.

**Inputs**

- Assignee (`responsible_id`, text): Only tasks assigned to this person.
- Status (`status`, text): Only tasks with this status. One of: `2` (Waiting to start), `3` (In progress), `4` (Waiting for review), `5` (Completed), `6` (Deferred).
- Project ID (`group_id`, text): Only tasks in this workgroup or project.
- Title contains (`search`, text): Only those whose title contains this.
- Created on or after (`created_after`, date): Only those created on or after this date.
- Start at (`start`, number): Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is another page
- `next_start` (number): The Start at value for the next page; 0 when this is the last
- `tasks` (list): The tasks
- `total` (number): How many match, on every page

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_start": 0,
  "tasks": [
    {
      "changedDate": "2026-11-02T10:06:08+02:00",
      "closedDate": "",
      "createdBy": "1",
      "createdDate": "2026-11-02T10:06:08+02:00",
      "deadline": "2026-11-09T18:00:00+02:00",
      "description": "Confirm the renewal terms.",
      "groupId": "0",
      "id": "3711",
      "priority": "1",
      "responsibleId": "1",
      "status": "2",
      "title": "Call Acme back"
    }
  ],
  "total": 1
}
```

### List users

List the people in your Bitrix24, with their emails, job titles and departments, optionally searching by name. Gets one page of 50; to see more, run it again with the next page it gives.

**Inputs**

- Search (`search`, text): A name, email or other detail to search for.
- Include people who have left (`include_inactive`, true/false): Also list users who have been dismissed.
- Start at (`start`, number): Lists come 50 at a time. Leave empty for the first page, or give the next_start from the page before. At least 0.

**Outputs**

- `count` (number): How many are on this page
- `has_more` (true/false): Whether there is another page
- `next_start` (number): The Start at value for the next page; 0 when this is the last
- `total` (number): How many match, on every page
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_start": 0,
  "total": 1,
  "users": [
    {
      "ACTIVE": true,
      "EMAIL": "weber@example.com",
      "ID": "1",
      "LAST_NAME": "Weber",
      "NAME": "Klaus",
      "UF_DEPARTMENT": [
        1
      ],
      "WORK_POSITION": "Sales Manager"
    }
  ]
}
```

### Send chat message

Send a message in Bitrix24 chat to a person or a group chat, as the person who made the webhook. Supports Bitrix24's formatting, such as [b]bold[/b].

**Inputs**

- Send to (`dialog_id`, text, required): A person, or a group chat (chat followed by its id, such as chat345).
- Message (`message`, text, required): What to say.

**Outputs**

- `dialog_id` (text): Where it was sent
- `message_id` (number): The message's id

**Example output**

```json
{
  "dialog_id": "chat345",
  "message_id": 34239
}
```

### Update contact

Change a contact's details, or add an email or phone number. Only the fields you fill in change.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's id, from 'List contacts' or an earlier step.
- First name (`first_name`, text): A new first name. Leave empty to keep it.
- Last name (`last_name`, text): A new last name. Leave empty to keep it.
- Add email (`add_email`, text): An email to add alongside the ones they have.
- Add phone (`add_phone`, text): A phone number to add alongside the ones they have.
- Position (`position`, text): Their job title.
- Company (`company_id`, text): The company it belongs to.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Comment (`comments`, text): Notes kept on the record.
- More fields (`more_fields`, object): Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.

**Outputs**

- `contact_id` (number): The contact's id
- `updated` (true/false): Always true once saved

**Example output**

```json
{
  "contact_id": 84,
  "updated": true
}
```

### Update deal

Change a deal's details, such as moving it to another stage or changing its amount. Only the fields you fill in change.

**Inputs**

- Deal ID (`deal_id`, text, required): The deal's id, from 'List deals' or an earlier step.
- Title (`title`, text): A new title. Leave empty to keep it.
- Stage (`stage_id`, text): Move the deal to this stage of its own pipeline.
- Amount (`opportunity`, number): The deal's value. At least 0.
- Currency (`currency_id`, text): The currency of the amount, such as USD.
- Contacts (`contact_ids`, list): The contacts it involves. Replaces the ones it has.
- Company (`company_id`, text): The company it belongs to.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Expected close date (`close_date`, date): When the deal is expected to close.
- Comment (`comments`, text): Notes kept on the record.
- More fields (`more_fields`, object): Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.

**Outputs**

- `deal_id` (number): The deal's id
- `updated` (true/false): Always true once saved

**Example output**

```json
{
  "deal_id": 410,
  "updated": true
}
```

### Update lead

Change a lead's details, such as its status or responsible person. Only the fields you fill in change.

**Inputs**

- Lead ID (`lead_id`, text, required): The lead's id, from 'List leads' or an earlier step.
- Title (`title`, text): A new title. Leave empty to keep it.
- First name (`first_name`, text): The person's first name.
- Last name (`last_name`, text): The person's last name.
- Add email (`add_email`, text): An email to add alongside the ones it has.
- Add phone (`add_phone`, text): A phone number to add alongside the ones it has.
- Status (`status_id`, text): The lead's status, such as New.
- Source (`source_id`, text): Where it came from, such as Website.
- Responsible person (`assigned_by_id`, text): The Bitrix24 user responsible for it.
- Amount (`opportunity`, number): The lead's expected value. At least 0.
- Currency (`currency_id`, text): The currency of the amount, such as USD.
- Comment (`comments`, text): Notes kept on the record.
- More fields (`more_fields`, object): Any other fields, by their Bitrix24 code, such as {"UF_CRM_1721244482250": "Gold", "UTM_SOURCE": "google"}. Custom fields' codes are shown in Bitrix24 under the field's settings.

**Outputs**

- `lead_id` (number): The lead's id
- `updated` (true/false): Always true once saved

**Example output**

```json
{
  "lead_id": 3465,
  "updated": true
}
```

### Update task

Change a task's title, description, assignee, deadline, priority or project. Only the fields you fill in change.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'List tasks' or an earlier step.
- Title (`title`, text): A new title. Leave empty to keep it.
- Description (`description`, text): What needs doing.
- Assignee (`responsible_id`, text): Who does it. Leave empty to assign it to the person who made the webhook.
- Deadline (`deadline`, date and time): When it is due.
- Priority (`priority`, text): How important the task is. Bitrix24 defaults to Medium. One of: `0` (Low), `1` (Medium), `2` (High).
- Project ID (`group_id`, text): The id of the workgroup or project the task belongs to, from its address in Bitrix24.

**Outputs**

- `task` (object): The task
- `task_id` (number): The task's id

**Example output**

```json
{
  "task": {
    "changedDate": "2026-11-02T10:06:08+02:00",
    "closedDate": "",
    "createdBy": "1",
    "createdDate": "2026-11-02T10:06:08+02:00",
    "deadline": "2026-11-09T18:00:00+02:00",
    "description": "Confirm the renewal terms.",
    "groupId": "0",
    "id": "3711",
    "priority": "1",
    "responsibleId": "1",
    "status": "2",
    "title": "Call Acme back"
  },
  "task_id": 3711
}
```
