---
title: "Region lookup"
method: GET
path: "/api/regions/{region_id}"
tags: ["Regions"]
---

# Region lookup

`GET /api/regions/{region_id}`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/regions/{region_id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/regions/:region_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get details for a specific region.

## Path parameters

- `region_id` string, required

## Response `200`

Returns OK for success.

- object
  - `ok` boolean: If true, indicates success.
  - `region` RegionObject: A Region object describes a geographical boundary or set of hardware identifiers and associated attributes that correspond to a physical location of relevance to the application or application owner.
    - `attributes` object: An attribute object is an object containing the customer-provided region attributes associated with a particular region.
    - `beacons` object[]: An array of beacon objects.
      - `id` string, required: The hardware ID of the beacon.
      - `name` string: The user-supplied name of the beacon.
    - `created_at` string, date-time, required: The creation [date-time](/developer/rest-api/ua/introduction/#date-time-format) for the region.
    - `geofence` union: A Geofence object describes a geographical boundary corresponding to a physical location of relevance to the application or application owner. The geofence `type` can be a `polygon`, a `circle`, or provided by a `confidential` source.
      - object: A Geofence subtype describing a polygon.
        - `points` PointObject[], required: An ordered array of Points that correspond to the vertices of the polygon on the globe.
          - `latitude` number, float, required: Decimal with maximum 6 digits of decimal precision in the range [-90,90].
          - `longitude` number, float, required: Decimal with maximum 6 digits of decimal precision in the range of [0, 180)
        - `type` 'POLYGON', required: The key `type` indicating a polygon geofence subtype.
      - object: A Geofence subtype describing a circle.
        - `center` PointObject, required: A Point object is a simple JSON object corresponding to a point on the globe, consisting of only two keys: latitude and longitude.
          - `latitude` number, float, required: Decimal with maximum 6 digits of decimal precision in the range [-90,90].
          - `longitude` number, float, required: Decimal with maximum 6 digits of decimal precision in the range of [0, 180)
        - `radius` integer, required: An integer indicating the size (in meters) of the radius of the circle whose edge is the geofence boundary.
        - `type` 'CIRCLE', required: The key `type` indicating a circle geofence subtype.
      - object: A confidential Geofence subtype.
        - `id` string, required: The source-specific identifier for this geofence.
        - `source` string, required: The name of the company providing the geofence.
        - `type` 'CONFIDENTIAL', required: The key `type` indicating a confidential geofence subtype.
        - `version` string, required: The version number for the source of this geofence.
    - `name` string: A human-readable name for the region.
    - `region_id` string, uuid, required: A string containing a UUID that is the canonical identifier for this object, elsewhere referred to as `region_id`.
    - `source_info` object: A Source Info object is a simple JSON object providing the details about the origin of the region data.
      - `region_id` string, required: Internal identifier used by source for this region.
      - `source` string, required: Name of the company who originated the region data.
      - `vendor_href` string: URI indicating the location of the original source of this region data.
    - `updated_at` string, date-time, required: The last updated [date-time](/developer/rest-api/ua/introduction/#date-time-format) for the region.

## Other responses

- `401`: Authentication information (the app key and secret or bearer token) was either incorrect or missing.
- `404`: The requested resource doesn't exist.

## Changes

- **2025-08-28** `3304568aaadc`: 1 breaking
  - added `subschema #1: Polygon Geofence object, subschema #2: Circle Geofence object, subschema #3: Confidential Geofence object` to the `region/geofence` response property `oneOf` list for the response status `200`
  - …this revision’s changelog is incomplete

[Operation history](https://skmtc.dev/airship/apis/airship-api/changes/api/regions/:region_id/get.md)

---

[API](https://skmtc.dev/airship/apis/airship-api.md) - [All operations](https://skmtc.dev/airship/apis/airship-api/llms.txt) - [OpenAPI document](https://skmtc.dev/airship/apis/airship-api/revisions/bd6ab947117a?raw)