For AI agents: markdown of this page — /docs-content-en/entities/recurring-deals/get.md documentation index — /llms.txt

Get recurring settings

GET /v1/recurring-deals/:id

Returns a deal recurrence setting by its ID. Use it to read the schedule, repetition limits and execution history.

Parameters

Parameter Type Required Description
Parameterid Typenumber RequiredYes DescriptionSetting ID in the request path. A non-negative safe integer. Get IDs from the recurring deal list
Parameterselect Typestring / string[] RequiredNo DescriptionSelect response fields, for example select=id,active

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/recurring-deals/1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/recurring-deals/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals/1', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const result = await response.json()
if (!result.success) throw new Error(result.error.message)
console.log(result.data)

JavaScript — OAuth application

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/recurring-deals/1', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN' },
})
const result = await response.json()
if (!result.success) throw new Error(result.error.message)
console.log(result.data)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionWhether the request succeeded
Fielddata Typeobject DescriptionRecurrence setting. See recurring deal fields

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "dealId": 575,
    "basedId": 573,
    "active": false,
    "categoryId": 1,
    "isLimit": "T",
    "counterRepeat": 2,
    "limitRepeat": 2,
    "limitDate": null,
    "startDate": "2020-06-15",
    "nextExecution": null,
    "lastExecution": "2020-06-16T22:00:00.000Z",
    "params": {
      "mode": "multiple",
      "singleBeforeStartDateValue": 0,
      "singleBeforeStartDateType": "day",
      "multipleType": "day",
      "multipleInterval": 1,
      "offsetBeginDateType": "day",
      "offsetBeginDateValue": 1,
      "offsetCloseDateType": "day",
      "offsetCloseDateValue": 1
    }
  }
}

Error response example

404 — setting not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Recurring deal is not found."
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS Descriptionid is not a non-negative safe integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe setting was not found. Bitrix24 message: Recurring deal is not found.
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe Bitrix24 call succeeded but returned no object. Message: recurringDeal <id> not found
HTTP422 CodeBITRIX_ERROR DescriptionFor id=0, Bitrix24 returns ID is not defined or invalid.
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeTOKEN_MISSING DescriptionNo Bitrix24 access tokens are configured
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the crm scope
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access, including a missing required scope
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the operation or a plan restriction applies. See error.message
HTTP503 CodeBITRIX_TIMEOUT DescriptionBitrix24 did not respond in time. Retry after the interval in Retry-After
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionA connection to Bitrix24 could not be established
HTTP429 CodeRATE_LIMITED DescriptionThe request rate limit was exceeded. Retry after the interval in the Retry-After header

For the full list of common API errors, see Error codes.

See also