Manager-stage questions

GET /v1/performan/review/manager/questions

Returns the manager-stage questions of a campaign: wording, type, whether an answer is mandatory, and the ordering. The campaign ID parameter is required, and the listing is cursor-based.

Parameters

Navigation

1. The first request carries no afterCursorId — it returns the first page.
2. Pass meta.nextCursor.id from the response as the afterCursorId parameter of the next request. Copy the cursor whole, never assemble it from record fields.
3. A response whose meta.nextCursor is null marks the end of the listing. The method has no offset parameter and no total count.

Examples

curl — personal key

curl "https://vibecode.bitrix24.com/v1/performan/review/manager/questions?campaignId=1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl "https://vibecode.bitrix24.com/v1/performan/review/manager/questions?campaignId=1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/performan/review/manager/questions?campaignId=1', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const body = await res.json()

if (!body.success) {
  throw new Error(`${body.error.code}: ${body.error.message}`)
}

// Text questions can be answered through the API, choice questions cannot
const answerable = body.data.filter((q) => q.type === '3')
console.log(answerable.map((q) => [q.id, q.title, q.required]))

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/performan/review/manager/questions?campaignId=1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const body = await res.json()

if (!body.success) {
  throw new Error(`${body.error.code}: ${body.error.message}`)
}

console.log(body.data, body.meta.nextCursor)

Response fields

Response example

{
  "success": true,
  "data": [
    {
      "id": 23,
      "campaignId": 1,
      "campaignStageId": 5,
      "title": "Comment",
      "description": "",
      "type": "3",
      "typeLabel": "Text answer",
      "required": false,
      "isRating": false,
      "sort": 90
    },
    {
      "id": 22,
      "campaignId": 1,
      "campaignStageId": 5,
      "title": "Final decisions",
      "description": "Tick the applicable items — input fields will appear.",
      "type": "2",
      "typeLabel": "Multiple choice",
      "required": false,
      "isRating": false,
      "sort": 80
    },
    {
      "id": 21,
      "campaignId": 1,
      "campaignStageId": 5,
      "title": "Final rating",
      "description": "",
      "type": "1",
      "typeLabel": "Single choice",
      "required": true,
      "isRating": true,
      "sort": 70
    }
  ],
  "meta": { "nextCursor": { "id": 21 } }
}

Error response example

400 — a required parameter was not sent:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`campaignId` is required and must be a positive integer"
  }
}

Errors

The full list of common API errors — Errors.

Known specifics

Unknown query parameters are ignored. The method reads campaignId, limit and afterCursorId and drops everything else without an error: a request with a typo in a parameter name returns 200 with an unfiltered listing. For instance, revieweeUserId narrows the listing only on manager review cards — on the other lists it is dropped silently.

The method does not return answer options. A question of type 1 or 2 has a list of options, but their IDs come neither from this method nor from a review card: the answers[].selectedOptions field carries only the options already chosen. Until an option is selected in the Bitrix24 interface, there is no way to obtain its ID, so only text questions of type 3 can be answered through the API.

The mandatory rating question blocks finalisation. A question with required: true and isRating: true is of type 1, single choice. Because of the limitation above, it cannot be answered through the API, so finalising the manager review with POST /v1/performan/review/manager/answers and isAutosave: false returns 422 BITRIX_ERROR with a message about unanswered mandatory fields.

The listing order is descending id, not the sort field. The sort field defines the order the questions have on the stage in the Bitrix24 interface and does not affect the order of records in the response. To show the questions the way an employee sees them, collect the whole list and sort it by ascending sort on your side.

See also

• Manager review cards
• Manager answer
• Review campaigns
• Performance review operations
• Errors