For AI agents: markdown of this page — /docs-content-en/polls/list.md documentation index — /llms.txt

Find polls by posts or messages

GET /v1/polls

Finds attached polls by post IDs or chat message IDs. Supply exactly one filter.

Results follow Bitrix24 visibility rules: when resultsVisible: false, counters and percentages are null, voters is empty and votersComplete is false. See the poll object for visibility rules.

Scope: vote. Key restrictions: Polls.

Parameters

Parameter Type Required Default Description
ParameterpostIds (query) Typestring Requiredone filter Default— Description1–50 comma-separated positive post IDs from List posts
ParametermessageIds (query) Typestring Requiredone filter Default— Description1–50 comma-separated positive message IDs from chat messages

Do not pass both filters or empty values. IDs must be safe positive integers without leading zeros. If any attachment is missing or inaccessible, the whole request returns 404 POLL_NOT_FOUND. Result order does not correspond to input order: match records using source.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/polls?postIds=42" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/polls?postIds=42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/polls?postIds=42', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const result = await res.json()

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/polls?postIds=42', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata[] Typeobject DescriptionPoll object for each matching attachment

Response example

Illustrative response based on the normalizer and test fixtures; not a live Bitrix24 response.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 7,
      "voteId": 8,
      "status": "active",
      "anonymous": true,
      "allowRevote": true,
      "resultsHidden": true,
      "resultsVisible": true,
      "votersCount": 3,
      "questions": [
        {
          "id": 10,
          "text": "First",
          "multipleChoice": false,
          "required": false,
          "votesCount": 0,
          "answers": [
            {
              "id": 11,
              "text": "One",
              "votesCount": 0,
              "percent": 0
            },
            {
              "id": 12,
              "text": "Two",
              "votesCount": 0,
              "percent": 0
            }
          ]
        },
        {
          "id": 20,
          "text": "Second",
          "multipleChoice": true,
          "required": true,
          "votesCount": 2,
          "answers": [
            {
              "id": 22,
              "text": "A",
              "votesCount": 2,
              "percent": 100
            },
            {
              "id": 23,
              "text": "B",
              "votesCount": 0,
              "percent": 0
            }
          ]
        }
      ],
      "myVote": {
        "voted": true,
        "answerIds": [
          22
        ]
      },
      "permissions": {
        "canVote": false,
        "canRevote": true,
        "canManage": true
      },
      "source": {
        "type": "post",
        "postId": 42
      }
    }
  ]
}

Errors

HTTP Code Cause and action
HTTP400 CodeINVALID_PARAMS Cause and actionInvalid ID or request parameter
HTTP401 CodeTOKEN_MISSING Cause and actionNo Bitrix24 user session
HTTP403 CodeSCOPE_DENIED Cause and actionRequired scope is missing
HTTP403 CodeCOWORK_READONLY Cause and actionOperation forbidden for a Cowork portal-readonly key
HTTP404 CodePOLL_NOT_FOUND Cause and actionPoll missing or inaccessible
HTTP403 CodePOLL_ACCESS_DENIED Cause and actionBitrix24 denied the operation
HTTP422 CodeBITRIX_ERROR Cause and actionBitrix24 rejected the request, for example because the method is unavailable in this version

Other authentication refusals, limits and shared errors: error codes.

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Invalid poll parameters."
  }
}