Sign in
Numbers

Numbers Datatable

Get paginated number details.

get/companies/{company}/numbers/datatable

Path parameters

companyinteger required

Query parameters

businessUnitIdinteger
{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:parameters:2:schema:items","oasType":"schema","type":"unknown"}
querystring
prefixesstring[]
{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:parameters:5:schema:items","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:parameters:6:schema:items","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:parameters:7:schema:items","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:parameters:8:schema:items","oasType":"schema","type":"unknown"}
patternsstring[]
{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:parameters:10:schema:items","oasType":"schema","type":"unknown"}
numberPoolTypeinteger[]
vanityboolean
isTrackingNumberboolean
isReadyForCampaignboolean
isSmsEnabledboolean
isMmsEnabledboolean
sortsstring[]
numberTemplateIdinteger
excludeNumberTemplateIdsinteger[]
selectedNumberIdsinteger[]
dniPoolIdsinteger[]
excludeDniPoolIdsinteger[]
sourcesstring[]

Filter by DNI pool source slugs (OR). Include an empty string to also match numbers without any source.

{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:parameters:24:schema:items","oasType":"schema","type":"unknown"}

Filter by call tracking status (OR). One or more of: not_in_pool, dni_disabled, dni_enabled_calls_only, dni_enabled_full.

onlyAssignableToNumberTemplatesboolean
isProvisionedboolean
minimalboolean

Same as fields = ['id', 'label', 'number']

fieldsstring[]

Specified which fields should be returned

searchRelatedEntityFields[]string[]

Specify which related entity fields to include in search. Available options: dniPoolLabel, numberTemplateName, tagName

Response

OK

{"stackTrail":"paths:/companies/{company}/numbers/datatable:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.