Numbers and Users

After a customer exists, use these endpoints to configure telephony and users.

Typical sequence

1. Discover area codes (optional)
2. Add numbers to the customer
3. Create users
4. Configure per-user settings
5. Read call activities

Area codes

GET /v2/numbers/area-codes
Authorization: Bearer <token>

Returns available geographic area codes with region labels — useful when choosing a new number.

Customer numbers

List

GET /v2/customers/{customerID}/numbers?limit=10&offset=0

Add

numberE164 must be in E.164 format without a leading + (for example 441234567890 for a UK number).

POST /v2/customers/{customerID}/numbers
Content-Type: application/json

{
  "numberE164": "441234567890"
}

Number records include status, type, allocation to a user, and porting fields — see API Reference → Customer Numbers.

Remove

• Delete a single number: DELETE /customers/{customerID}/numbers/{numberID}
• Bulk delete: DELETE /customers/{customerID}/numbers with a body listing number IDs

Refer to Reference for exact request bodies.

Customer users

List and create

GET /v2/customers/{customerID}/users
POST /v2/customers/{customerID}/users

Bulk user creation is available — see API Reference for the bulk endpoint and payload.

Single user

GET /v2/customers/{customerID}/users/USERID
PATCH /v2/customers/{customerID}/users/USERID
DELETE /v2/customers/{customerID}/users/USERID

User settings

Per-user call settings:

GET /v2/customers/{customerID}/users/USERID/settings
PATCH /v2/customers/{customerID}/users/USERID/settings

Use Reference for available settings fields.

User devices

Manage devices registered to a user:

GET /v2/customers/{customerID}/users/USERID/devices
POST /v2/customers/{customerID}/users/USERID/devices
DELETE /v2/customers/{customerID}/users/USERID/devices/{deviceID}

Activities (call history)

GET /v2/customers/{customerID}/users/USERID/activities?datefrom=2025-01-01&limit=50

Filter by datefrom, dateto, type, and direction — see Reference.

Webhooks

Subscribe to user_created and user_deleted for automation — Webhooks.