Catalog

Locations / regions

Changed on

Returns the catalog of locations (regions), each with an id, name, city, country, and region, plus latitude and longitude when they are set.

Requires the catalog.read permission. See Permissions for the roles and API key permissions that include it.

get/v1/locations

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/locations
  • Auth
    HTTP bearer

Response

Locations

citystring required
countrystring required
idstring required
latitudenumber
longitudenumber
namestring required
regionstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status