Get Recurring Deal Template Settings by ID crm.deal.recurring.get

Scope: crm

Who can execute the method: user with "read" access permission for deals

The method crm.deal.recurring.get returns the fields of the recurring deal template settings by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id^*
integer

Identifier of the recurring deal template settings.

The identifier can be obtained using the methods crm.deal.recurring.list or crm.deal.recurring.add

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.recurring.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":15,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.recurring.get

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.recurring.get',
        		{
        			id: 15,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info('Template settings:', result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.deal.recurring.get',
                    [
                        'id' => 15,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Recurring settings: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting recurring settings: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.recurring.get',
            {
                id: 15
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.info(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.recurring.get',
            [
                'id' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": "25",
                "DEAL_ID": "7591",
                "BASED_ID": "7577",
                "ACTIVE": "Y",
                "CATEGORY_ID": "2",
                "IS_LIMIT": "D",
                "COUNTER_REPEAT": null,
                "LIMIT_REPEAT": null,
                "LIMIT_DATE": "2027-03-05T03:00:00+01:00",
                "START_DATE": "2026-04-05T03:00:00+01:00",
                "NEXT_EXECUTION": "2026-04-05T01:00:00+01:00",
                "LAST_EXECUTION": "",
                "PARAMS": {
                    "MODE": "multiple",
                    "SINGLE_BEFORE_START_DATE_TYPE": null,
                    "SINGLE_BEFORE_START_DATE_VALUE": 0,
                    "MULTIPLE_TYPE": "month",
                    "MULTIPLE_INTERVAL": 1,
                    "OFFSET_BEGINDATE_TYPE": "day",
                    "OFFSET_BEGINDATE_VALUE": 1,
                    "OFFSET_CLOSEDATE_TYPE": "month",
                    "OFFSET_CLOSEDATE_VALUE": 2
                }
            },
            "time": {
                "start": 1772753726,
                "finish": 1772753726.940512,
                "duration": 0.94051194190979,
                "processing": 0,
                "date_start": "2026-03-06T02:35:26+01:00",
                "date_finish": "2026-03-06T02:35:26+01:00",
                "operating_reset_at": 1772754326,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `recurring_deal`	Root element of the response. Contains fields of the recurring deal template settings
time `time`	Information about the request execution time

Type recurring_deal

Name `type`	Description
ID `integer`	Identifier of the record in the recurring deal settings table
DEAL_ID `integer`	Identifier of the deal for which the recurrence is set
BASED_ID `integer`	Identifier of the deal on which the template is based
ACTIVE `char`	Active flag. Possible values: `Y` — active `N` — inactive
NEXT_EXECUTION `datetime`	Date and time of the next deal creation from the template
LAST_EXECUTION `datetime`	Date and time of the last deal creation from the template. May be an empty string if there have been no executions yet
COUNTER_REPEAT `integer`	Number of deals created from the template.
START_DATE `datetime`	Date to start calculating the next execution. Returned in the format `YYYY-MM-DDTHH:MI:SS+TZD`
CATEGORY_ID `char`	Identifier of the funnel for created deals
IS_LIMIT `char`	Type of limitation on deal creation: `N` — no limitations `D` — by date (`LIMIT_DATE`) `T` — by quantity (`LIMIT_REPEAT`)
LIMIT_REPEAT `integer`	Maximum number of deals to be created. Used when `IS_LIMIT = T`
LIMIT_DATE `datetime`	End date for deal generation. Used when `IS_LIMIT = D`. Returned in the format `YYYY-MM-DDTHH:MI:SS+TZD`
PARAMS `object`	Recurrence parameters (detailed description)

Fields of the PARAMS Object

Name `type`	Description
MODE `string`	Recurrence mode: `single` — single `multiple` — multiple
MULTIPLE_TYPE `string`	Period type for `MODE = multiple`: `day` `week` `month` `year`
MULTIPLE_INTERVAL `integer`	Recurrence interval for `MODE = multiple`
SINGLE_BEFORE_START_DATE_TYPE `string`	Offset type for `MODE = single`: `day` `week` `month` `year`
SINGLE_BEFORE_START_DATE_VALUE `integer`	Offset value for `MODE = single`. For `MODE = multiple`, it usually returns `0`
OFFSET_BEGINDATE_TYPE `string`	Type of offset for the start date of the created deal: `day` `week` `month` `year`
OFFSET_BEGINDATE_VALUE `integer`	Offset value for the start date of the created deal
OFFSET_CLOSEDATE_TYPE `string`	Type of offset for the end date of the created deal: `day` `week` `month` `year`
OFFSET_CLOSEDATE_VALUE `integer`	Offset value for the end date of the created deal

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Recurring deal is not found."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`id is not defined or invalid`	The parameter `id` has been passed with an empty or incorrect value
`Recurring is not allowed`	Recurring deals are not available in Bitrix24
`Recurring deal is not found`	The recurring deal template was not found
`Access denied`	Insufficient rights to read the recurring deal template

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Modify an Existing Setting for the Regular Deal Template

Get the List of Regular Deal Template Settings

Get Recurring Deal Template Settings by ID crm.deal.recurring.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type recurring_dealType recurring_deal

Fields of the PARAMS ObjectFields of the PARAMS Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning