catalog.userfield.document.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["documentType","documentId","field7097"],"filter":{"documentType":"A","documentId":81},"order":{"documentId":"ASC"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.userfield.document.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 UserfieldDocumentListResult = {
  documents: Array<{
    documentId: number
    documentType: string
    field7097: string
  }>
}

// catalog.userfield.document.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.
try {
  const response = await $b24.actions.v2.call.make<UserfieldDocumentListResult>({
    method: 'catalog.userfield.document.list',
    params: {
      select: ['documentType', 'documentId', 'field7097'],
      filter: { documentType: 'A', documentId: 81 },
      order: { documentId: 'ASC' },
      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(result.documents, `page size: ${result.documents.length}`)
  }
} 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 listUserfieldDocuments() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // catalog.userfield.document.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: 'catalog.userfield.document.list',
        params: {
          select: ['documentType', 'documentId', 'field7097'],
          filter: { documentType: 'A', documentId: 81 },
          order: { documentId: 'ASC' },
          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(result.documents, `page size: ${result.documents.length}`)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.userfield.document.list(
        select=[
            "documentType",
            "documentId",
            "field7097",
        ],
        filter={
            "documentType": "A",
            "documentId": 81,
        },
        order={
            "documentId": "ASC",
        },
        start=0,
    ).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(
            'catalog.userfield.document.list',
            [
                'select' => ['documentType', 'documentId', 'field7097'],
                'filter' => ['documentType' => 'A', 'documentId' => 81],
                'order' => ['documentId' => 'ASC'],
                'start' => 0
            ]
        );

    print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
    echo $exception->getMessage();
}

BX24.callMethod(
    'catalog.userfield.document.list',
    {
        select: ['documentType', 'documentId', 'field7097'],
        filter: { documentType: 'A', documentId: 81 },
        order:  { documentId: 'ASC' }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());

            if (result.more()) {
                result.next();
            }
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'catalog.userfield.document.list',
    [
        'select' => ['documentType', 'documentId', 'field7097'],
        'filter' => ['documentType' => 'A', 'documentId' => 81],
        'order' => ['documentId' => 'ASC'],
        'start' => 0
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.userfield.document.list", b24.Params{
	"select": []string{"documentType", "documentId", "field7097"},
	"filter": b24.Params{
		"documentType": "A",
		"documentId":   81,
	},
	"order": b24.Params{
		"documentId": "ASC",
	},
	"start": 0,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.userfield.document.list: %w", err)
}

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

var items []struct {
	DocumentID   b24.ID `json:"documentId"`
	DocumentType string `json:"documentType"`
	Field7097    string `json:"field7097"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.DocumentID)
}