Skip to content
aerandil.com
GitHub

The caller's Web Push subscriptions

GET
/v1/push-subscriptions
curl --request GET \
  --url https://api.aerandil.com/v1/push-subscriptions \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The caller’s own endpoints, newest first.

Media typeapplication/json
object
data
required
Array<object>
object
app_url

web only.

string format: uri
created_at
required
string format: date-time
declarative
required
boolean
endpoint
required

The push resource URL (web) or the device token (apns / fcm).

string
id
required
string format: uuid
idempotent_replay

Present and true when the response was replayed for a repeated Idempotency-Key.

boolean
last_delivered_at
string format: date-time
platform
required
string
Allowed values: web apns fcm
staff_member_id
required

The staff member the endpoint currently delivers to.

string format: uuid
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
user_agent
string
Example
{
  "data": [
    {
      "platform": "web"
    }
  ]
}

403

Section titled “403”

The bearer authenticated but does not hold the scope this operation requires.

Media typeapplication/json

Structured error wrapper. Every non-2xx response from any Aerandil endpoint serialises to this shape; the HTTP status carries the failure class (4xx/5xx), the body adds a stable code for programmatic dispatch plus a human-readable message.

object
error
required
object
code
required

Stable, programmatic error code (e.g. unauthorized, forbidden, not_found, invalid_body, invalid_url, precondition_failed, no_secondary_key). Clients dispatch on code, not on the message (which may be localised or contextualised in future versions).

string
instance_id

Request-id correlation handle echoed on the request-id response header — support teams correlate without scraping logs.

string
message
required

Human-readable explanation of the failure.

string
parameters

Per-error structured detail. The shape varies by code (e.g. forbidden_action carries {"action": "..."}; precondition_failed carries {"current_version": N}).

Examplegenerated
{
  "error": {
    "code": "example",
    "instance_id": "example",
    "message": "example",
    "parameters": "example"
  }
}