Developer API Reference

Get all Location Subscriptions

Retrive all subscriptions associated with the location

GET /v1/locations/{locationId}/subscriptions

Response Body

A successful request returns the HTTP 200 OK status code and a JSON response body with a list of all the subscriptions for this location

page number
Current page of the returned subscriptions
perPage number
Number of subscriptions returned per page
pageCount string
Number of pages available
total number
Total number of subscriptions
subscriptions array
A list of all the subscriptions
GET /v1/locations/{locationId}/subscriptions HTTP/1.1
Content-Type: application/json
Authorization: Bearer {}
HTTP/1.1 200 OK
Content-Type: application/json

{
  "page": 1,
  "perPage": 5,
  "pageCount": 1,
  "total": 2,
  "subscriptions": [ {
    "subscriptionId": "3bb2255b...2a48",
    "locationId": "be926a02...dbc9",
    "endpoint": "https://www.exampleurl.com",
    "status": "pending"
  },{
    "subscriptionId": "8402255b...9302",
    "locationId": "be926a02...dbc9",
    "endpoint": "https://example-endpoint.com",
    "status": "confirmed"
  }]
}