REST · WebSocket
GuardPath API · v1
Production-ready, versioned API. All endpoints return JSON. Auth via Bearer tokens issued from Clerk.
Base URL
48
Endpoints
99.98%
Uptime
120ms
p95
Authentication
POST/v1/auth/session
Exchange Clerk JWT for a GuardPath session token.
{
"token": "eyJhbGci...",
"user": { "id": "u_01J...", "role": "parent" }
}POST/v1/auth/refresh
Refresh an expiring session token.
DELETE/v1/auth/session
Revoke current session.
Children
GET/v1/children
List all child profiles under the account.
[
{ "id": "c_01", "name": "Liam", "status": "safe" }
]POST/v1/children
Create a new child profile.
PATCH/v1/children/:id
Update a child profile.
DELETE/v1/children/:id
Remove a child profile.
Devices
GET/v1/devices
List all GuardTag devices on the account.
POST/v1/devices/pair
Pair a new GuardTag by serial number.
{
"serial": "EV-2241-A8FC",
"child_id": "c_01"
}POST/v1/devices/:id/locate
Force-refresh device location.
Safe zones
GET/v1/zones
List safe zones for the account.
POST/v1/zones
Create a circular safe zone with center + radius.
{
"name": "Home",
"lat": 37.7694,
"lng": -122.4312,
"radius_m": 80
}PATCH/v1/zones/:id
Update zone radius, center, or active state.
DELETE/v1/zones/:id
Remove a safe zone.
Alerts
GET/v1/alerts
Paginated alert feed for the account.
POST/v1/alerts/:id/resolve
Mark an alert resolved.
GET/v1/alerts/stream
WebSocket: realtime alert subscription via Ably.
Voice
POST/v1/voice/call/:device_id
Initiate a two-way Twilio voice call.
POST/v1/voice/listen/:device_id
Open a one-way listen-in stream.
Webhooks
POST/v1/webhooks/stripe
Subscription lifecycle events.
POST/v1/webhooks/shopify
Hardware order fulfillment events.
POST/v1/webhooks/traccar
Raw position events from device gateway.
SDKs ready
Official JavaScript, Swift & Kotlin clients · OpenAPI 3.1 spec available · Postman collection on request.