List regions

GET /api/accounts/{account_id}/regions
Api key

Returns a list of regions for an account, paginated according to the pagination parameters.

Path parameters

  • account_id string Required

    The ID of the account for which to list the regions

Query parameters

  • filter string

    criteria to filter by

  • sort string

    criteria to sort by

  • limit string

    amount of results per page to return

  • page string

    page number

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • data array[object]

      Regions data

      Hide data attributes Show data attributes object
      • account_id string

        ID of the account the region belongs to

      • booth_count number

        Number of booths associated to this region

      • facility_count number

        Number of facilities associated to this region

      • id string

        ID of the region in the system

      • is_default string

        Whether the region is the account's default region or not

        Values are true or false.

      • name string

        Name of the region

    • limit number

      The number of items per page currently applied

    • page number

      The number of the page returned

    • pages number

      The total number of pages matching the current search

    • total number

      The total number of regions matching the query
  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
GET /api/accounts/{account_id}/regions 
curl \
 --request GET 'http://localhost:4000/api/accounts/{account_id}/regions' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "name": "Test Region",
      "account_id": "a9299bca-acc2-4dde-1111-83a08ca12128",
      "is_default": true,
      "booth_count": 10,
      "facility_count": 5
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}
Response examples (401) 
{
  "error": "Error Reason"
}