[GET] Number details

This API is used to get meta-data of listed business numbers like their updated at, created by etc.

Get Numbers

get

This endpoint returns all numbers under a client. It supports pagination and filtering based on department/operation/process/feature_set It will return an empty array if no numbers are found.

Authorizations
Path parameters
client_account_idstringRequired

Client Account ID of the caller, taken from path params

Query parameters
department_idstringOptional

Department ID - to filter by department

feature_set_idstringOptional

Feature Set ID - to filter by feature set

operation_idstringOptional

Operation ID - to filter by operation

process_idstringOptional

Process ID - to filter by process or subprocess

limitinteger · int64Optional

Limit per page

pageinteger · int64Optional

Current page number

Responses
200Success
get
GET /clients/{clientAccountId}/number_management/numbers HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Copy query param IDs from self-serve
Process / Subprocess ID & feature-set ID can be copied from self-serve console.

Last updated

Was this helpful?