Developer API Reference

Get a Subscription

GET /v1/subscriptions/{subscriptionId}

Retrieve subscription details by subscriptionId

Response Body

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the following subscription details.

subscriptionId string
subscription identifier
locationId string
location identifier
endpoint string
A secured Fully Qualified Domain Url endpoint that receives location alerts
status string
status of the subscription
GET /v1/subscriptions/{subscriptionId} HTTP/1.1
Content-Type: application/json
Authorization: Bearer {}
{
  "subscriptionId": "3bb2255b...2a48",
  "locationId": "be926a02...dbc9",
  "endpoint": "https://example-endpoint.com",
  "status": "confirmed"
}