Get Values of All Fields in a Property Group by ID sale.propertygroup.get
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho can execute the method: administrator
This method allows you to retrieve the values of all fields in a property group.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the property group |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":10}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.propertygroup.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":10,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.propertygroup.get
try
{
const response = await $b24.callMethod(
"sale.propertygroup.get", {
"id": 10
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.propertygroup.get',
[
'id' => 10,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting sale property group: ' . $e->getMessage();
}
BX24.callMethod(
"sale.propertygroup.get", {
"id": 10
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.propertygroup.get',
[
'id' => 10
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"propertyGroup": {
"id": 10,
"name": "Delivery Service",
"personTypeId": 4,
"sort": 100
}
},
"time": {
"start": 1711455022.718165,
"finish": 1711455022.90226,
"duration": 0.18409514427185059,
"processing": 0.018402099609375,
"date_start": "2024-03-26T15:10:22+02:00",
"date_finish": "2024-03-26T15:10:22+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
propertyGroup |
Information about the property group |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": 200940400001,
"error_description": "property group does not exist"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Property group not found |
|
|
Insufficient permissions to read the property group |
|
|
Parameter |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Property Groups in the Online Store: Overview of Methods
- Create Property Group sale.propertygroup.add
- Update Property Group Fields sale.propertygroup.update
- Get a list of property groups sale.propertygroup.list
- Delete Property Group sale.propertygroup.delete
- Get Available Fields of Property Groups sale.propertygroup.getFields