Get Data of Attached Vote vote.AttachedVote.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: vote

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

The method vote.AttachedVote.get returns data of the attached vote.

Method Parameters

There are three options for calling the method.

1. By Attached Poll ID

Required parameters are marked with *

Name `type`	Description
attachId* `integer`	ID of the attached vote, can be equal to `voteId` from the results of vote.Integration.Im.send

2. By Poll Element

Required parameters are marked with *

Name `type`	Description
moduleId* `string`	Module ID, possible values: `Im` for a poll in chat, `blog` for a poll in the feed
entityType* `string`	Object type, possible values: `Bitrix\\Vote\\Attachment\\ImMessageConnector` for a poll in chat, `Bitrix\\Vote\\Attachment\\BlogPostConnector` for a poll in the feed
entityId* `integer`	Element ID, possible values: `id` of the chat message with the poll, can be obtained using the method vote.Integration.Im.send, `id` of the post with the poll in the feed, can be obtained using the method log.blogpost.get

3. By Signed ID

Required parameters are marked with *

Name `type`	Description
signedAttachId* `string`	Signed attachment ID, can be obtained using the method vote.AttachedVote.get, response parameter `signedAttachId`

Code Examples

How to Use Examples in Documentation

Example call by the ID of the attached poll.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"attachId":**put_attach_id**}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.AttachedVote.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"attachId":**put_attach_id**,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/vote.AttachedVote.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AttachedVoteGetResult = {
          attach: {
            ID: number
            VOTE_ID: number
            COUNTER: number
            QUESTIONS: Record<string, unknown>
            ANONYMITY: number
            OPTIONS: number
            userAnswerMap: Record<string, unknown>
            canEdit: boolean
            canVote: boolean
            canRevote: boolean
            isVoted: boolean
            signedAttachId: string
            resultUrl: string
            downloadUrl: string
            entityId: number
            isFinished: boolean
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AttachedVoteGetResult>({
            method: 'vote.AttachedVote.get',
            params: {
              attachId: 1,
            },
            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(result.attach.ID, result.attach.signedAttachId, result.attach.isVoted)
          }
        } 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 getAttachedVote() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'vote.AttachedVote.get',
                params: {
                  attachId: 1,
                },
                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(result.attach.ID, result.attach.signedAttachId, result.attach.isVoted)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getAttachedVote)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.vote.attached_vote.get(
                attach_id=1,
            ).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(
                    'vote.AttachedVote.get',
                    [
                        'attachId' => **put_attach_id**
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            "vote.AttachedVote.get",
            {
                "attachId": **put_attach_id**
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'vote.AttachedVote.get',
            [
                'attachId' => **put_attach_id**
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Example call by the element associated with the poll.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"im","entityType":"Bitrix\\Vote\\Attachment\\ImMessageConnector","entityId":32221}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.AttachedVote.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"im","entityType":"Bitrix\\Vote\\Attachment\\ImMessageConnector","entityId":32221,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/vote.AttachedVote.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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type AttachedVoteGetResult = {
          attach: {
            ID: number
            VOTE_ID: number
            COUNTER: number
            QUESTIONS: Record<string, unknown>
            ANONYMITY: number
            OPTIONS: number
            userAnswerMap: Record<string, unknown>
            canEdit: boolean
            canVote: boolean
            canRevote: boolean
            isVoted: boolean
            signedAttachId: string
            resultUrl: string
            downloadUrl: string
            entityId: number
            isFinished: boolean
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<AttachedVoteGetResult>({
            method: 'vote.AttachedVote.get',
            params: {
              moduleId: 'im',
              entityType: 'Bitrix\\Vote\\Attachment\\ImMessageConnector',
              entityId: 32221,
            },
            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(result.attach.ID, result.attach.signedAttachId, result.attach.isVoted)
          }
        } 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 getAttachedVoteByEntity() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'vote.AttachedVote.get',
                params: {
                  moduleId: 'im',
                  entityType: 'Bitrix\\Vote\\Attachment\\ImMessageConnector',
                  entityId: 32221,
                },
                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(result.attach.ID, result.attach.signedAttachId, result.attach.isVoted)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getAttachedVoteByEntity)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.vote.attached_vote.get(
                module_id="Im",
                entity_type="Bitrix\\Vote\\Attachment\\ImMessageConnector",
                entity_id=32221,
            ).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(
                    'vote.AttachedVote.get',
                    [
                        'moduleId' => 'im',
                        'entityType' => 'Bitrix\\Vote\\Attachment\\ImMessageConnector',
                        'entityId' => 32221
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            "vote.AttachedVote.get",
            {
                "moduleId": "im",
                "entityType": "Bitrix\\Vote\\Attachment\\ImMessageConnector",
                "entityId": 32221
            },
            function(result)
            {
                if(result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.dir(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'vote.AttachedVote.get',
            [
                'moduleId' => 'im',
                'entityType' => 'Bitrix\\Vote\\Attachment\\ImMessageConnector',
                'entityId' => 32221
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "vote.AttachedVote.get", b24.Params{
        	"moduleId":   "im",
        	"entityType": "Bitrix\\Vote\\Attachment\\ImMessageConnector",
        	"entityId":   32221,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("vote.AttachedVote.get: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Response Handling

HTTP Status: 200

{
          "attach": {
            "ID": 1,
            "VOTE_ID": 1,
            "COUNTER": 1,
            "QUESTIONS": {
              "1": {
                "ID": "1",
                "ACTIVE": "Y",
                "TIMESTAMP_X": "2025-08-05T09:08:31+02:00",
                "VOTE_ID": "1",
                "C_SORT": "10",
                "COUNTER": "1",
                "QUESTION": "How are you?",
                "QUESTION_TYPE": "text",
                "IMAGE_ID": null,
                "DIAGRAM": "Y",
                "DIAGRAM_TYPE": "histogram",
                "REQUIRED": "N",
                "FIELD_TYPE": "0",
                "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                "IMAGE": null,
                "ANSWERS": {
                  "1": {
                    "ID": "1",
                    "ACTIVE": "Y",
                    "TIMESTAMP_X": "2025-08-05T09:08:31+02:00",
                    "QUESTION_ID": "1",
                    "C_SORT": "10",
                    "IMAGE_ID": null,
                    "MESSAGE": "Great!",
                    "MESSAGE_TYPE": "text",
                    "COUNTER": "1",
                    "FIELD_TYPE": "0",
                    "FIELD_WIDTH": "0",
                    "FIELD_HEIGHT": "0",
                    "FIELD_PARAM": null,
                    "COLOR": "",
                    "REACTION": "",
                    "~FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                    "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                    "MESSAGE_FIELD_NAME": "bx_vote_event[1][MESSAGE][1][1]",
                    "~PERCENT": 100,
                    "PERCENT": 100
                  },
                  "3": {
                    "ID": "3",
                    "ACTIVE": "Y",
                    "TIMESTAMP_X": "2025-08-05T09:08:31+02:00",
                    "QUESTION_ID": "1",
                    "C_SORT": "20",
                    "IMAGE_ID": null,
                    "MESSAGE": "Best of all!",
                    "MESSAGE_TYPE": "text",
                    "COUNTER": "0",
                    "FIELD_TYPE": "0",
                    "FIELD_WIDTH": "0",
                    "FIELD_HEIGHT": "0",
                    "FIELD_PARAM": null,
                    "COLOR": "",
                    "REACTION": "",
                    "~FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                    "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                    "MESSAGE_FIELD_NAME": "bx_vote_event[1][MESSAGE][1][3]",
                    "~PERCENT": 0,
                    "PERCENT": 0
                  },
                  "5": {
                    "ID": "5",
                    "ACTIVE": "Y",
                    "TIMESTAMP_X": "2025-08-05T09:08:31+02:00",
                    "QUESTION_ID": "1",
                    "C_SORT": "30",
                    "IMAGE_ID": null,
                    "MESSAGE": "What's up??",
                    "MESSAGE_TYPE": "text",
                    "COUNTER": "0",
                    "FIELD_TYPE": "0",
                    "FIELD_WIDTH": "0",
                    "FIELD_HEIGHT": "0",
                    "FIELD_PARAM": null,
                    "COLOR": "",
                    "REACTION": "",
                    "~FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                    "FIELD_NAME": "bx_vote_event[1][BALLOT][1]",
                    "MESSAGE_FIELD_NAME": "bx_vote_event[1][MESSAGE][1][5]",
                    "~PERCENT": 0,
                    "PERCENT": 0
                  }
                }
              }
            },
            "ANONYMITY": 1,
            "OPTIONS": 1,
            "userAnswerMap": {
              "1": {
                "1": {
                  "EVENT_ID": "1",
                  "EVENT_QUESTION_ID": "1",
                  "ANSWER_ID": "1",
                  "ID": "1",
                  "MESSAGE": ""
                }
              }
            },
            "canEdit": true,
            "canVote": false,
            "canRevote": true,
            "isVoted": true,
            "signedAttachId": "1.52280488561bf567f33cf03b5ce353e154a9c3552b51b2ffb67be3bb7f26f986",
            "resultUrl": "/vote-result/me7hn922bm011mbf",
            "downloadUrl": "/bitrix/services/main/ajax.php?action=vote.AttachedVote.download&SITE_ID=s1&signedAttachId=1.52280488561bf567f33cf03b5ce353e154a9c3552b51b2ffb67be3bb7f26f986",
            "entityId": 13,
            "isFinished": false
          }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Contains the `attach` object with information about the attached vote, structure described below
time `time`	Information about the request execution time

Response Element attach

Name `type`	Description
ID `integer`	ID of the attached vote
VOTE_ID `integer`	ID of the vote itself
COUNTER `integer`	Vote counter
QUESTIONS `array`	Array of poll questions
ANONYMITY `integer`	Level of poll anonymity
OPTIONS `integer`	Availability of revoting
userAnswerMap `array`	Map of current user's answers
canEdit `boolean`	Can the current user edit the poll
canVote `boolean`	Can the current user vote
canRevote `boolean`	Can the current user revote
isVoted `boolean`	Has the current user already voted
signedAttachId `string`	Signed ID
resultUrl `string`	URL to view poll results
downloadUrl `string`	URL to download poll results
entityId `integer`	ID of the element to which the poll is attached
isFinished `boolean`	Is the poll finished

Error Handling

HTTP Status: 400

{
            "error": "ATTACH_NOT_FOUND",
            "error_description": "Attach not found"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description
`ATTACH_NOT_FOUND`	Vote not found
`ATTACH_READ_ACCESS_DENIED`	No permission to participate in the vote

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Was the article helpful?

Stop Voting

Get List of Voters for an Answer

Get Data of Attached Vote vote.AttachedVote.get

Method ParametersMethod Parameters

1. By Attached Poll ID1. By Attached Poll ID

2. By Poll Element2. By Poll Element

3. By Signed ID3. By Signed ID

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Response Element attachResponse Element attach

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

1. By Attached Poll ID

2. By Poll Element

3. By Signed ID

Code Examples

Response Handling

Returned Data

Response Element attach

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning