Skip to main content
GET
Get clean numbers

Authorizations

collectwise_key
string
header
required

Active, unexpired API key belonging to an active organization. Optional organization/key signing and organization IP restrictions also apply; see API Access.

Headers

x-cw-timestamp
string

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

Pattern: ^(0|[1-9][0-9]*)$
x-cw-signature
string

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Pattern: ^v1=[0-9a-f]{64}$

Query Parameters

group
enum<string>
required

The group of clean numbers to retrieve

Available options:
overseas,
inhouse,
sms_inbound

Response

Clean numbers retrieved successfully

numbers
object[]
required

List of active clean phone numbers

count
integer
required

Total number of clean numbers returned

group
enum<string>
required

The group that was queried

Available options:
overseas,
inhouse,
sms_inbound