API reference
API reference
Every endpoint resellers and their customers can call, with its fields, who may call it, and an example request and response.
AuthenticationSign in for a bearer token, sign out, and read the signed-in user's organization and permissions.3 endpointsOrganizationsCreate and manage your customer organizations, their status and default plans, and your own white-label branding.7 endpointsUsersInvite users into your organization or your customers', change their roles, and deactivate or remove them.7 endpointsDevicesImport SIMs, activate, suspend and deactivate them one at a time or 500 per request, and assign them to customers.15 endpointsUsageRead daily usage per device and totals per device, customer and month, or export them as CSV.6 endpointsMessagesRead the messages your devices sent, follow each delivery attempt, and retry deliveries from the dead letter queue.6 endpointsWebhook endpointsThe URLs a customer's messages are delivered to, and their signing secrets.8 endpointsPlansCreate the retail plans you bill your customers on, priced on top of your wholesale plans.7 endpointsInvoicesYour monthly invoices to customers and from HoundSat, their device-level lines, previews and totals.11 endpointsAudit logWho changed what in your organization and your customers', newest first.2 endpoints
OpenAPI spec
The whole API is also described by an OpenAPI 3 document, for generating a client or importing into Postman or Insomnia. It is the source these pages are built from.
curl https://api.houndsat.com/api/json/open_api -o houndsat-openapi.json