Skip to main content
Version: v1

Regions

Many of the BAV resources rely on segmenting data by country. Countries in turn belong to different geographical regions. This resource contains a list of all the regions.

List Regions​

To list all of the regions and browse them via the API, use the list endpoint:

GET /api/v1/regions

The brand list response contains details about the region.

Schema​

KeyTypeDescription
idintegerThe system ID for the region.
namestringThe name of the region in english.
{
    "data": [
        {
            "id": 7,
            "name": "Africa"
        }
        //...
    ]
    // ...
}

Get a Region​

You may also directly retrieve a region's details if you already have its system ID.

GET /api/v1/regions/123

Where 123 is the system ID of the region.

Schema​

KeyTypeDescription
idintegerThe system ID for the region.
namestringThe name of the region in english.
{
    "data": {
        "id": 7,
        "name": "Africa"
    }
}

Configurable Fields​

If you only need some of the fields you can optimize the request for a leaner response ( see Configurable Fields for more information). The following fields can be toggled:

  • name

Expansions​

To create a leaner response data related to brands are not included in the response by default. See the Expansions section for more information on how this works. The following relationships can be expanded:

  • countries - A slimmer list of countries that belong to this region.

Filters​

The regions endpoint supports the following filters:

Sorting​

The following fields are sortable:

  • id
  • name