Get List of Forum Message Custom Fields forum.message.field.custom.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","userTypeId","isMultiple","editFormLabel"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/forum.message.field.custom.list
        

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CustomFieldListResult = {
          items: Array<{
            id: number
            name: string
            userTypeId: string
            isMultiple: boolean
            editFormLabel: string | null
          }>
        }
        
        try {
          const response = await $b24.actions.v3.call.make<CustomFieldListResult>({
            method: 'forum.message.field.custom.list',
            params: {
              select: ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            result.items.forEach(field => console.info(field.id, field.name, field.userTypeId))
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listCustomFields() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'forum.message.field.custom.list',
                params: {
                  select: ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              result.items.forEach(field => console.info(field.id, field.name, field.userTypeId))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listCustomFields)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.forum.message.field.custom.list(
                select=["id", "name", "userTypeId", "isMultiple", "editFormLabel"],
            ).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(
                    'forum.message.field.custom.list',
                    [
                        'select' => ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

BX24.callMethod(
            'forum.message.field.custom.list',
            {
                select: ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

require_once('crest.php');
        
        $result = CRest::call(
            'forum.message.field.custom.list',
            [
                'select' => ['id', 'name', 'userTypeId', 'isMultiple', 'editFormLabel'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "forum.message.field.custom.list", b24.Params{
        	"select": []string{"id", "name", "userTypeId", "isMultiple", "editFormLabel"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("forum.message.field.custom.list: %w", err)
        }
        
        // The method wraps the list in an object with the "items" key.
        raw, ok := b24.Unwrap(res.Result, "items")
        if !ok {
        	return fmt.Errorf("no items key in the response")
        }
        
        var items []struct {
        	ID            int     `json:"id"`
        	Name          string  `json:"name"`
        	UserTypeID    string  `json:"userTypeId"`
        	IsMultiple    bool    `json:"isMultiple"`
        	EditFormLabel *string `json:"editFormLabel"`
        }
        if err := json.Unmarshal(raw, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, field := range items {
        	fmt.Println(field.ID, field.Name, field.UserTypeID)
        }