Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform
Join our community

Actions290

Overview

The Bitrix24 node's "Get Items" operation for the "SPA" (Smart Process Automation) resource allows users to retrieve items from a specified Smart Process type within Bitrix24. This is useful for automating workflows, reporting, or integrating Bitrix24 SPA data with other systems.

Typical use cases include:

  • Fetching all or a limited number of SPA items filtered by specific criteria.
  • Retrieving SPA items sorted in a particular order.
  • Selecting only certain fields from SPA items to optimize data handling.

For example, a user might want to get all SPA items of a certain type where the stage is "NEW" and created after a specific date, ordered by creation date descending, and only return the ID, title, and creator fields.

Properties

Name Meaning
Authentication Method to authenticate with Bitrix24:
- OAuth2 (recommended for production)
- Webhook (simpler but less secure)
- API Key authentication
Return All Whether to return all matching results or limit the output to a maximum number of pages.
Max pages to load Maximum number of pages to load when not returning all results. Each page contains up to 50 items.
Type ID The Smart Process type identifier to specify which SPA type's items to retrieve. This is required.
Options Collection of additional options to customize the query:
- Filter: JSON object specifying filter conditions using Bitrix24 filter syntax (e.g., { "STAGE_ID": "NEW" })
- Order: JSON object defining sorting order (e.g., { "ID": "ASC" })
- Select: Comma-separated list of fields to return (empty means all fields)

Output

The node outputs an array of items under the json property. Each item corresponds to a SPA item retrieved from Bitrix24 and includes the fields requested via the "Select" option or all fields if none specified.

If binary data were involved (not indicated here), it would be included separately, but this operation focuses on JSON data representing SPA items.

The output structure per item typically looks like:

{
  "ID": "123",
  "TITLE": "Example Item",
  "CREATED_BY": "User ID",
  "DATE_CREATE": "2023-01-01T12:00:00Z",
  ...
}

Fields depend on the SPA type and selected fields.

Dependencies

  • Requires connection to Bitrix24 via one of the supported authentication methods (OAuth2, webhook URL, or API key).
  • Needs proper configuration of credentials in n8n for the chosen authentication method.
  • Uses Bitrix24 API endpoints related to Smart Process Automation (crm.item.fields, crm.type.list, etc.).
  • Pagination support requires handling of Bitrix24 API pagination tokens.

Troubleshooting

  • Common issues:

    • Incorrect or missing authentication credentials will cause authorization errors.
    • Providing an invalid or empty SPA Type ID will result in failure to fetch items.
    • Malformed JSON in the "Filter" or "Order" options can cause API call failures.
    • Exceeding API rate limits may cause temporary request failures.

  • Error messages:

    • Errors returned from Bitrix24 API are surfaced as error messages in the node execution.
    • If "Continue On Fail" is enabled, errors are returned as JSON objects with error and timestamp fields.
    • Common resolution steps include verifying credentials, checking the SPA Type ID, validating JSON syntax in filters/orders, and ensuring API limits are respected.

Links and References

Discussion