Skip to main content
GET
/
v3
/
regions
Browse Regions
curl --request GET \
  --url http://localhost/api/v3/regions
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "handle": "<string>",
      "countries": [
        {
          "id": 123,
          "name": "<string>",
          "iso_2": "<string>",
          "iso_3": "<string>",
          "iso_numeric": "<string>",
          "sort_order": 123,
          "states": [
            {
              "id": 123,
              "name": "<string>",
              "type": "<string>",
              "iso": "<string>",
              "iso_2_country": "<string>",
              "iso_2_country_state_code": "<string>",
              "sort_order": 123,
              "created_at": "<string>",
              "updated_at": "<string>"
            }
          ],
          "currency": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "region": {
            "id": "<string>",
            "name": "<string>",
            "handle": "<string>",
            "is_default": "<string>"
          }
        }
      ],
      "is_default": true,
      "currency": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

page[size]
string

Response

Array of Region

data
Region · object[]
required