Overview

The V4MOS.AI Bitrix24 API gives you the raw records synced from the Bitrix24 accounts connected to your organization: deals, leads, contacts, deal stage and lead status history, pipelines and statuses. Rows come as they were synced, with the warehouse column names (snake_case), so you can load them straight into your BI. All endpoints use the /v1/bitrix24 prefix and the same authentication, pagination and response format.

Getting startedCopy Anchor Link

Base URL: https://data.v4mos.ai. Every call requires your API credentials and the organizationId — see Authentication.

1. Connect Bitrix24 in app.v4mos.ai (Connected accounts) and wait for the first sync.
2. Call any endpoint below with your organizationId, for example GET /v1/bitrix24/deals?organizationId=….
3. Every row carries integration_id and integration_name: the connected account it came from. To read a single account, pass that value as integrationId.

Available endpointsCopy Anchor Link

• getDeals/v1/bitrix24/dealsOne row per deal: pipeline (category), stage, amount, currency, source, UTMs, contacts, company, owner and close date.
• getLeads/v1/bitrix24/leadsOne row per lead: status, source, UTMs, contact, company, owner and amount.
• getContacts/v1/bitrix24/contactsOne row per contact: source, UTMs, company and owner.
• getDeal stage history/v1/bitrix24/deal-stage-historyOne row per stage change of a deal: new stage, its semantic (in progress, won, lost) and pipeline.
• getLead status history/v1/bitrix24/lead-status-historyOne row per status change of a lead: new status and its semantic.
• getPipelines/v1/bitrix24/pipelinesOne row per deal pipeline (category), with its order and default flag.
• getStatuses/v1/bitrix24/statusesOne row per status of a CRM entity (deal stages, lead statuses, sources...), with its semantic and pipeline.

ResourcesCopy Anchor Link

Pagination and filtersCopy Anchor Link

• page (default 1) and limit (default 500, max 5000). meta.hasNextPage says whether another page exists; rows come in a stable order, so walk the pages until it is false.
• dateFrom / dateTo (YYYY-MM-DD, inclusive) filter by the date column shown in the table above. Resources without one reject them.
• integrationId keeps the rows of one connected account.
• Answers are cached for 30 minutes and the data is synced once a day — see Data sync.

Response formatCopy Anchor Link

{
  "data": [{ "...": "one object per row, with the columns listed on each endpoint" }],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Amounts and large counters (fields with format: decimal or format: int64 in each endpoint schema) come as strings, e.g. "125.50", so no precision is lost. Convert them to a decimal type on your side.