API reference

The complete REST API reference. Endpoints are organized by resource. Every request is authenticated with a Bearer token in the Authorization header.

This page is the high-level index. Endpoint-by-endpoint reference pages are in active publication — the listing below reflects the API as it stands today; the linked detail pages will land progressively.

Numbers

• GET /api/numbers — list your hosted SIMs.
• POST /api/numbers/order — provision a new number from the shared pool.
• POST /api/numbers/claim-shared — claim a number you already own across organizations.
• POST /api/numbers/claim-virtual — claim a virtual / BYOS number.
• POST /api/numbers/{id}/lock / /unlock — temporary exclusive access.
• PATCH /api/numbers/{id}/alias — set a human-readable alias.

Messages

• GET /api/messages — paginated message history, with filters.
• GET /api/messages/{id} — single message detail.
• POST /api/messages — send an outbound SMS (subject to plan).

Teams

• GET / POST / PATCH / DELETE /api/teams — manage teams.
• POST /api/teams/{id}/members — add a member.
• DELETE /api/teams/{id}/members/{user} — remove a member.

Webhooks

• GET / POST / PATCH / DELETE /api/teams/{team}/webhooks — manage webhook subscriptions.
• POST /api/teams/{team}/webhooks/{id}/test — fire a test event.
• GET /api/teams/{team}/webhooks/{id}/logs — delivery history.

API keys

• GET / POST / PATCH / DELETE /api/api-keys — manage API keys.
• POST /api/api-keys/{id}/regenerate — rotate the secret.

Versioning

The current API is the unversioned default. When we ship a breaking change, it gets a new version prefix (e.g., /api/v2/...) and the old version continues to work for at least 12 months. The changelog announces deprecations.