sale.property.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","active","code","defaultValue","description","inputFieldLocation","isAddress","isAddressFrom","isAddressTo","isEmail","isFiltered","isLocation","isLocation4tax","isPayer","isPhone","isProfileName","isZip","multiple","name","personTypeId","propsGroupId","required","settings","sort","type","userProps","util","xmlId"],"filter":{"@type":"STRING","%code":"EMAIL"},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.property.list

// 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 SalePropertyListResult = {
  properties: {
    id: number
    active: string
    code: string
    defaultValue: string
    description: string
    inputFieldLocation: string
    isAddress: string
    isAddressFrom: string
    isAddressTo: string
    isEmail: string
    isFiltered: string
    isLocation: string
    isPayer: string
    isPhone: string
    isProfileName: string
    isZip: string
    multiple: string
    name: string
    personTypeId: number
    propsGroupId: number
    required: string
    settings: unknown
    sort: number
    type: string
    userProps: string
    util: string
    xmlId: string
  }[]
}

try {
  // sale.property.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<SalePropertyListResult>({
    method: 'sale.property.list',
    params: {
      select: [
        'id',
        'active',
        'code',
        'defaultValue',
        'description',
        'inputFieldLocation',
        'isAddress',
        'isAddressFrom',
        'isAddressTo',
        'isEmail',
        'isFiltered',
        'isLocation',
        'isLocation4tax',
        'isPayer',
        'isPhone',
        'isProfileName',
        'isZip',
        'multiple',
        'name',
        'personTypeId',
        'propsGroupId',
        'required',
        'settings',
        'sort',
        'type',
        'userProps',
        'util',
        'xmlId',
      ],
      filter: {
        '@type': 'STRING',
        '%code': 'EMAIL',
      },
      order: {
        id: 'desc',
      },
      start: 0,
    },
    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('Properties on page:', result.properties.length, result.properties[0]?.name)
  }
} 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 fetchPropertyList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // sale.property.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'sale.property.list',
        params: {
          select: [
            'id',
            'active',
            'code',
            'defaultValue',
            'description',
            'inputFieldLocation',
            'isAddress',
            'isAddressFrom',
            'isAddressTo',
            'isEmail',
            'isFiltered',
            'isLocation',
            'isLocation4tax',
            'isPayer',
            'isPhone',
            'isProfileName',
            'isZip',
            'multiple',
            'name',
            'personTypeId',
            'propsGroupId',
            'required',
            'settings',
            'sort',
            'type',
            'userProps',
            'util',
            'xmlId',
          ],
          filter: {
            '@type': 'STRING',
            '%code': 'EMAIL',
          },
          order: {
            id: 'desc',
          },
          start: 0,
        },
        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('Properties on page:', result.properties.length, result.properties[0]?.name)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchPropertyList)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.property.list(
        select=[
            "id",
            "active",
            "code",
            "defaultValue",
            "description",
            "inputFieldLocation",
            "isAddress",
            "isAddressFrom",
            "isAddressTo",
            "isEmail",
            "isFiltered",
            "isLocation",
            "isLocation4tax",
            "isPayer",
            "isPhone",
            "isProfileName",
            "isZip",
            "multiple",
            "name",
            "personTypeId",
            "propsGroupId",
            "required",
            "settings",
            "sort",
            "type",
            "userProps",
            "util",
            "xmlId",
        ],
        filter={
            "@type": "STRING",
            "%code": "EMAIL",
        },
        order={
            "id": "desc",
        },
        start='1712818881.719586',
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'sale.property.list',
            [
                'select' => [
                    'id',
                    'active',
                    'code',
                    'defaultValue',
                    'description',
                    'inputFieldLocation',
                    'isAddress',
                    'isAddressFrom',
                    'isAddressTo',
                    'isEmail',
                    'isFiltered',
                    'isLocation',
                    'isLocation4tax',
                    'isPayer',
                    'isPhone',
                    'isProfileName',
                    'isZip',
                    'multiple',
                    'name',
                    'personTypeId',
                    'propsGroupId',
                    'required',
                    'settings',
                    'sort',
                    'type',
                    'userProps',
                    'util',
                    'xmlId',
                ],
                'filter' => [
                    '@type' => 'STRING',
                    '%code' => 'EMAIL',
                ],
                'order' => [
                    'id' => 'desc',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching sale properties: ' . $e->getMessage();
}

BX24.callMethod(
    "sale.property.list", {
        "select": [
            "id",
            "active",
            "code",
            "defaultValue",
            "description",
            "inputFieldLocation",
            "isAddress",
            "isAddressFrom",
            "isAddressTo",
            "isEmail",
            "isFiltered",
            "isLocation",
            "isLocation4tax",
            "isPayer",
            "isPhone",
            "isProfileName",
            "isZip",
            "multiple",
            "name",
            "personTypeId",
            "propsGroupId",
            "required",
            "settings",
            "sort",
            "type",
            "userProps",
            "util",
            "xmlId",
        ],
        "filter": {
            "@type": "STRING",
            "%code": "EMAIL",
        },
        "order": {
            "id": "desc",
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'sale.property.list',
    [
        'select' => [
            "id",
            "active",
            "code",
            "defaultValue",
            "description",
            "inputFieldLocation",
            "isAddress",
            "isAddressFrom",
            "isAddressTo",
            "isEmail",
            "isFiltered",
            "isLocation",
            "isLocation4tax",
            "isPayer",
            "isPhone",
            "isProfileName",
            "isZip",
            "multiple",
            "name",
            "personTypeId",
            "propsGroupId",
            "required",
            "settings",
            "sort",
            "type",
            "userProps",
            "util",
            "xmlId",
        ],
        'filter' => [
            "@type" => "STRING",
            "%code" => "EMAIL",
        ],
        'order' => [
            "id" => "desc",
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.property.list", b24.Params{
	"select": []string{"id", "active", "code", "defaultValue", "description", "inputFieldLocation", "isAddress", "isAddressFrom", "isAddressTo", "isEmail", "isFiltered", "isLocation", "isLocation4tax", "isPayer", "isPhone", "isProfileName", "isZip", "multiple", "name", "personTypeId", "propsGroupId", "required", "settings", "sort", "type", "userProps", "util", "xmlId"},
	"filter": b24.Params{
		"@type": "STRING",
		"%code": "EMAIL",
	},
	"order": b24.Params{
		"id": "desc",
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.property.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "properties".
raw, ok := b24.Unwrap(res.Result, "properties")
if !ok {
	return fmt.Errorf("в ответе нет ключа properties")
}

var items []struct {
	Active             string `json:"active"`
	Code               string `json:"code"`
	DefaultValue       string `json:"defaultValue"`
	Description        string `json:"description"`
	ID                 b24.ID `json:"id"`
	InputFieldLocation string `json:"inputFieldLocation"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.Active)
}