crm-requisite-preset-countries.md

Get a List of Countries for the Template crm.requisite.preset.countries

{% note tip "" %}

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.

{% endnote %}

Scope: crm

Who can execute the method: any user

The method returns a possible list of countries for requisite templates. Country identifiers are used as values for the COUNTRY_ID field of the template.

No parameters.

Code Examples

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.countries

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/crm.requisite.preset.countries

• JS (TS)

  // 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 each country item returned in result[]
  type CountryItem = {
    ID: number,
    CODE: string,
    TITLE: string,
  }
  
  try {
    const response = await $b24.actions.v2.call.make<CountryItem[]>({
      method: 'crm.requisite.preset.countries',
      params: {},
      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('Countries count:', result.length, 'First country:', result[0])
    }
  } catch (error) {
    // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
    console.error(error)
  }

• JS (UMD)

  <!-- 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 fetchCountries() {
      try {
        // Initialize the SDK inside a Bitrix24 frame
        const $b24 = await B24Js.initializeB24Frame()
  
        const response = await $b24.actions.v2.call.make({
          method: 'crm.requisite.preset.countries',
          params: {},
          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('Countries count:', result.length, 'First country:', result[0])
      } catch (error) {
        // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
        console.error(error)
      }
    }
  
    document.addEventListener('DOMContentLoaded', fetchCountries)
  </script>

• Python

  from b24pysdk.errors import BitrixAPIError, BitrixSDKException
  
  try:
      bitrix_response = client.crm.requisite.preset.countries().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}")

• PHP

  try {
      $response = $b24Service
          ->core
          ->call(
              'crm.requisite.preset.countries',
              []
          );
  
      $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 fetching countries: ' . $e->getMessage();
  }

• BX24.js

  BX24.callMethod(
      "crm.requisite.preset.countries",
      {},
      function(result)
      {
          if(result.error())
              console.error(result.error());
          else
              console.dir(result.data());
      }
  );

• PHP CRest

  require_once('crest.php');
  
  $result = CRest::call(
      'crm.requisite.preset.countries',
      []
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

• Go

  // client and ctx are already created — see the Go SDK section
  res, err := client.Core().Call(ctx, "crm.requisite.preset.countries", nil)
  if err != nil {
  	return fmt.Errorf("crm.requisite.preset.countries: %w", err)
  }
  
  var items []struct {
  	ID    b24.ID `json:"ID"`
  	Code  string `json:"CODE"`
  	Title string `json:"TITLE"`
  }
  if err := json.Unmarshal(res.Result, &items); err != nil {
  	return fmt.Errorf("parse response: %w", err)
  }
  for _, it := range items {
  	fmt.Println(it.ID, it.Code)
  }

{% endlist %}

Response Handling

HTTP status: 200

{
    "result": [
        {
            "ID": 1,
            "CODE": "RU",
            "TITLE": "United States"
        },
        {
            "ID": 4,
            "CODE": "BY",
            "TITLE": "Belarus"
        },
        {
            "ID": 6,
            "CODE": "KZ",
            "TITLE": "Kazakhstan"
        },
        {
            "ID": 14,
            "CODE": "UA",
            "TITLE": "Ukraine"
        },
        {
            "ID": 34,
            "CODE": "BR",
            "TITLE": "Brazil"
        },
        {
            "ID": 46,
            "CODE": "DE",
            "TITLE": "Germany"
        },
        {
            "ID": 77,
            "CODE": "CO",
            "TITLE": "Colombia"
        },
        {
            "ID": 110,
            "CODE": "PL",
            "TITLE": "Poland"
        },
        {
            "ID": 122,
            "CODE": "US",
            "TITLE": "United States"
        },
        {
            "ID": 132,
            "CODE": "FR",
            "TITLE": "France"
        }
    ],
    "time": {
        "start": 1716549490.84839,
        "finish": 1716549491.239788,
        "duration": 0.39139795303344727,
        "processing": 0.017835140228271484,
        "date_start": "2024-05-24T13:18:10+02:00",
        "date_finish": "2024-05-24T13:18:11+02:00",
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result array | An array of objects describing countries || || time time | Information about the request execution time || |#

Fields of the Country Object

#| || Name type | Description || || ID integer | Identifier || || CODE string | Character code according to the ISO 3166-1 standard || || TITLE string | Name || |#

Error Handling

{% include System errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}