Retrieve a paginated list of active phone numbers for a specific account. Supports filtering, pagination, and optional exclusion of number pool assignments.
Retrieve a paginated list of active phone numbers for a specific account. Supports filtering, pagination, and optional exclusion of number pool assignments.
http
GET https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}
Authorization
Name
Type
Required
Example
Description
Authorization
string
Yes
Bearer token generated from the Leadway portal. See Authentication.
Version
string
Yes
2021-07-28
API version.
Path parameters
Name
Type
Required
Example
Description
locationId
string
Yes
ve9EPM428h8vShlRW1KT
The unique identifier of the account
Query parameters
Name
Type
Required
Example
Description
pageSize
number
No
100
How many resources to return in each list page. The default is 50, and the maximum is 1000.
page
number
No
The page index for pagination. The default is 0.
searchFilter
string
No
+91
Filter numbers by phone number pattern. Supports partial matching (e.g., "+91" to find all Indian numbers).
skipNumberPool
boolean
No
True
Whether to exclude numbers that are assigned to number pools. Default is true.
Responses
200 - Successfully retrieved list of active numbers
numbers (object[], required): Array of phone number objects with detailed configuration
phoneNumber (string, required): E.164 formatted phone number Example: +14155552671
friendlyName (string): Human-readable name assigned to the number Example: Sales Line 1
sid (string, required): Phone number SID (unique identifier) Example: PN1234567890abcdef1234567890abcde
countryCode (string, required): ISO 3166-1 alpha-2 country code Example: US
capabilities (object, required): Communication capabilities supported by this number
voice (boolean): Whether the number supports voice calls Example: True
sms (boolean): Whether the number supports SMS messaging Example: True
mms (boolean): Whether the number supports MMS messaging Example: True
fax (boolean): Whether the number supports fax transmission Example: False
type (string, required): Type of phone number (local, toll-free, mobile, etc.) Possible values: 'local', 'toll-free', 'mobile', 'national' Example: local
isDefaultNumber (boolean, required): Whether this is the default outbound number for the account Example: False
linkedUser (string): User ID of the user assigned to this number Example: user_123456789
linkedRingAllUsers (string[], required): Array of user IDs that should ring when this number is called
inboundCallService (object): Configuration for inbound call handling service
type (string): Type of inbound call service Possible values: 'voice_ai', 'ivr', 'forward' Example: voice_ai
value (string): Service configuration value or ID Example: 68e381b296a83800a27cd1
forwardingNumber (string): Phone number to forward calls to Example: +14155552672
isGroupConversationEnabled (boolean, required): Whether group conversations are enabled for this number (US/CA numbers with SMS/MMS only) Example: True
addressSid (string): Address SID for compliance purposes Example: AD1234567890abcdef1234567890abcde
bundleSid (string): Bundle SID for regulatory compliance Example: BU1234567890abcdef1234567890abcde
dateAdded (string): When the number was originally purchased/added Example: 2023-01-15T10:30:00Z
dateUpdated (string): When the number configuration was last updated Example: 2023-02-20T14:45:00Z
origin (string): Source or origin of the phone number Possible values: 'twilio', 'hosted', 'ported' Example: twilio
isUnderGhl (boolean, required): Whether this account is manged by LeadconnectorHQ Example: True
pageSize (number, required): Number of items requested per page Example: 100
page (number, required): Current page index (0-based) Example: 0
accountStatus (string, required): Current status of the account Possible values: 'active', 'suspended', 'closed' Example: active