Get Recurring Deal Template Settings by ID crm.deal.recurring.get
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho 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 |
Description |
|
id* |
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 -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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CrmDealRecurring = {
ID: string
DEAL_ID: string
BASED_ID: string
ACTIVE: string
CATEGORY_ID: string
IS_LIMIT: string
COUNTER_REPEAT: string | null
LIMIT_REPEAT: string | null
LIMIT_DATE: ISODate | null
START_DATE: ISODate | null
NEXT_EXECUTION: ISODate | null
LAST_EXECUTION: ISODate | null
PARAMS: {
MODE: string
MULTIPLE_TYPE: string
MULTIPLE_INTERVAL: number
}
}
try {
const response = await $b24.actions.v2.call.make<CrmDealRecurring>({
method: 'crm.deal.recurring.get',
params: {
id: 15,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Recurring template:', result.ID, result.ACTIVE)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getRecurringDeal() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.recurring.get',
params: {
id: 15,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Recurring template:', result.ID, result.ACTIVE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRecurringDeal)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.recurring.get(bitrix_id=77).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.deal.recurring.get", b24.Params{
"id": 15,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.deal.recurring.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
DealID b24.ID `json:"DEAL_ID"`
BasedID b24.ID `json:"BASED_ID"`
Active string `json:"ACTIVE"`
CategoryID b24.ID `json:"CATEGORY_ID"`
IsLimit string `json:"IS_LIMIT"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.DealID)
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 |
Description |
|
result |
Root element of the response. Contains fields of the recurring deal template settings |
|
time |
Information about the request execution time |
Type recurring_deal
|
Name |
Description |
|
ID |
Identifier of the record in the recurring deal settings table |
|
DEAL_ID |
Identifier of the deal for which the recurrence is set |
|
BASED_ID |
Identifier of the deal on which the template is based |
|
ACTIVE |
Active flag. Possible values:
|
|
NEXT_EXECUTION |
Date and time of the next deal creation from the template |
|
LAST_EXECUTION |
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 |
Number of deals created from the template. |
|
START_DATE |
Date to start calculating the next execution. Returned in the format |
|
CATEGORY_ID |
Identifier of the funnel for created deals |
|
IS_LIMIT |
Type of limitation on deal creation:
|
|
LIMIT_REPEAT |
Maximum number of deals to be created. Used when |
|
LIMIT_DATE |
End date for deal generation. Used when Returned in the format |
|
PARAMS |
Recurrence parameters (detailed description) |
Fields of the PARAMS Object
|
Name |
Description |
|
MODE |
Recurrence mode:
|
|
MULTIPLE_TYPE |
Period type for
|
|
MULTIPLE_INTERVAL |
Recurrence interval for |
|
SINGLE_BEFORE_START_DATE_TYPE |
Offset type for
|
|
SINGLE_BEFORE_START_DATE_VALUE |
Offset value for For |
|
OFFSET_BEGINDATE_TYPE |
Type of offset for the start date of the created deal:
|
|
OFFSET_BEGINDATE_VALUE |
Offset value for the start date of the created deal |
|
OFFSET_CLOSEDATE_TYPE |
Type of offset for the end date of the created deal:
|
|
OFFSET_CLOSEDATE_VALUE |
Offset value for the end date of the created deal |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "Recurring deal is not found."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
The parameter |
|
|
Recurring deals are not available in Bitrix24 |
|
|
The recurring deal template was not found |
|
|
Insufficient rights to read the recurring deal template |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Get the List of Fields for the Recurring Deal Template crm.deal.recurring.fields
- Get a List of Recurring Deal Template Settings crm.deal.recurring.list
- Create a Template for Recurring Deal crm.deal.recurring.add
- Update the Recurring Deal Template Settings crm.deal.recurring.update
- Delete the Recurring Deal Template Setting crm.deal.recurring.delete
- Create a New Deal from the Template crm.deal.recurring.expose