regions

Requires at least one of the permissions settings:regional:read or settings:tenant:read.

Lists the platform's regions. They are shared by every organization. Requires permission to read regional or tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Regions {
  regions {
    id
    code
    countryCode
    stateCode
    name
    cityName
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Regions {\n  regions {\n    id\n    code\n    countryCode\n    stateCode\n    name\n    cityName\n  }\n}"
}
EOF

Response:

{
  "data": {
    "regions": [
      {
        "id": "id",
        "code": "string",
        "countryCode": "string",
        "stateCode": "string",
        "name": "string",
        "cityName": "string"
      }
    ]
  }
}

regions: [Region!]!

Type

Region object

A region such as a country, state or city.