Rent a number
- Open Phone numbers in the dashboard.
- Search the available standard US numbers and select one.
- Review the monthly rental, then complete checkout as the workspace owner.
- Wait for provisioning to complete before sending messages.
Read numbers through the API
numbers:read permits:
GET /v1/phone-numbersto list assigned numbers and onboarding status.GET /v1/phone-numbers/{id}to read one number.GET /v1/phone-numbers/available?country=USto search inventory.
cursor and limit (1–100, default 100). Inventory search returns at most ten candidates with no cursor. Availability can change before checkout.
POST /v1/phone-numbers assigns an existing paid rental and requires numbers:provision plus an idempotency key. New rentals are purchased through the owner checkout flow; an API key cannot create a billing checkout.
Release a number
DELETE /v1/phone-numbers/{id} requires numbers:release and an Idempotency-Key. Poll the returned operation until it reaches a terminal status.
Cancelled rentals release their number after the paid period. Unpaid rentals are suspended and may be released after seven days without paid coverage.