List fixed locations | Aura Panic API

Every filter on this operation narrows the same query and they combine freely, with one exception: installerIdentifier and customerSourceId both name the owning source, so supplying both is a contradiction rather than a narrower search and is rejected. Results are ordered by ascending id, so limit and offset page through them predictably.

Callout-scoped tokens cannot read this endpoint. Use a server token.

Lists fixed locations across your whole estate: the sites belonging to your own customer source and the sites belonging to each of your installers. Every entry reports its owner as `installerIdentifier`, which is `null` for your own sites. If you have no installers, the response is exactly what it has always been. Use `externalReferenceId` for exact reconciliation against an identifier maintained by your integration. Point-of-contact details are omitted from this collection response; retrieve the fixed location by its AURA `id` when contact details are required. Every filter on this operation narrows the same query and they combine freely, with one exception: `installerIdentifier` and `customerSourceId` both name the owning source, so supplying both is a contradiction rather than a narrower search and is rejected. Results are ordered by ascending `id`, so `limit` and `offset` page through them predictably. Callout-scoped tokens cannot read this endpoint. Use a server token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

installerIdentifierstringOptional>=1 character

Narrows the response to the sites owned by one of your installers. The value must be an installerIdentifier returned by GET /panic-api/v2/installers. Matching is exact and case sensitive. An unknown value is rejected, and so is an empty one: ?installerIdentifier= does not mean “my own sites”. To select those, pass your own customerSourceId instead. Cannot be combined with customerSourceId.

Narrows the response to the sites owned by one of your installers. The value must be an `installerIdentifier` returned by `GET /panic-api/v2/installers`. Matching is exact and case sensitive. An unknown value is rejected, and so is an empty one: `?installerIdentifier=` does not mean "my own sites". To select those, pass your own `customerSourceId` instead. Cannot be combined with `customerSourceId`.

customerSourceIdintegerOptional

Narrows the response to the sites owned by exactly one customer source, which must be your own or one of your installers’. This identifies an AURA customer source, so it is not the same thing as customerId, which identifies an end customer. It is the only way to select just your own sites, and the only way to select an installer that has no installerIdentifier set. Both values come from GET /panic-api/v2/installers, as self.customerSourceId and each installer’s customerSourceId. Cannot be combined with installerIdentifier.

Narrows the response to the sites owned by exactly one customer source, which must be your own or one of your installers'. This identifies an AURA customer source, so it is not the same thing as `customerId`, which identifies an end customer. It is the only way to select just your own sites, and the only way to select an installer that has no `installerIdentifier` set. Both values come from `GET /panic-api/v2/installers`, as `self.customerSourceId` and each installer's `customerSourceId`. Cannot be combined with `installerIdentifier`.

customerIdintegerOptional

Narrows the response to the sites linked to one end customer. Contrast customerSourceId, which selects by owning installer or monitoring centre: this selects on a different dimension, so the two can be combined to mean “that customer’s sites owned by that source”. Sites belonging to customer sources outside your estate are never returned, whatever this is set to.

Narrows the response to the sites linked to one end customer. Contrast `customerSourceId`, which selects by owning installer or monitoring centre: this selects on a different dimension, so the two can be combined to mean "that customer's sites owned by that source". Sites belonging to customer sources outside your estate are never returned, whatever this is set to.

externalReferenceIdstringOptional1-255 characters

Exact, case-sensitive match against the integrator-owned fixed-location reference. The value is not constrained as unique, so the response can contain more than one match.

limitintegerOptional1-100Defaults to 100

Maximum number of fixed locations to return. Values outside 1 to 100 are not rejected: they fall back to 100, as does a value that is not a number.

offsetintegerOptional>=0Defaults to 0

Number of matching fixed locations to skip. A negative value, or one that is not a number, is treated as 0.

searchstringOptional

Case-insensitive prefix match against locationIdentifier.

Response

Successful.

limitintegerOptional

offsetintegerOptional

totalintegerOptional

datalist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

Callout-scoped tokens cannot read this endpoint. Use a server token.