Reference
Changelog
Changes to the public API, newest first. Additive changes ship within v1; anything that could break a working integration gets a new version.
v1 · October 2026
First public version of the API.
- GET/v1/meRetrieve your account
- GET/v1/servicesList services
- GET/v1/countriesList countries
- GET/v1/quoteGet quotes
- POST/v1/ordersCreate an order
- GET/v1/ordersList orders
- GET/v1/orders/{id}Retrieve an order
- POST/v1/orders/{id}/cancelCancel an order
- POST/v1/orders/{id}/finishFinish an order
- GET/v1/rentals/quoteQuote a rental
- POST/v1/rentalsRent a number
- GET/v1/rentalsList rentals
- GET/v1/rentals/{id}Retrieve a rental
- POST/v1/rentals/{id}Update a rental
- GET/v1/rentals/{id}/messagesList rental messages
- POST/v1/rentals/{id}/cancelCancel a rental
Plus signed webhooks for order.code_received, order.expired, order.cancelled, rental.message_received, webhook.test, and the OpenAPI document.
Compatibility
Within v1 we may, without notice:
- add endpoints, optional parameters, response fields, error codes and webhook event types;
- change human-readable messages, and the format of opaque strings such as ids and cursors.
Write clients that ignore unknown fields and event types, and switch on error.code rather than messages. Anything else gets a new version and an entry here first.