Skip to main content
GET
List customers

Authorizations

X-API-Key
string
header
required

Your Voxfra management API key. Passed as a request header.

Format: vox_mgmt_<random>

Query Parameters

client_id
string<uuid>

Filter by client UUID. The client must belong to the authenticated organization.

phone_number
string

Exact normalized phone number filter

customer_status
enum<string>

Filter by customer lifecycle status

Available options:
new,
returning,
unknown
limit
integer
default:50

Number of results to return (max 200, default 50)

Required range: 1 <= x <= 200
offset
integer
default:0

Number of results to skip for pagination

Required range: x >= 0

Response

Paginated list of customers

data
object[]
pagination
object