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

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
locationIdstringYesve9EPM428h8vShlRW1KTThe unique identifier of the account

Query parameters

NameTypeRequiredExampleDescription
pageSizenumberNo100How many resources to return in each list page. The default is 50, and the maximum is 1000.
pagenumberNoThe page index for pagination. The default is 0.
searchFilterstringNo+91Filter numbers by phone number pattern. Supports partial matching (e.g., "+91" to find all Indian numbers).
skipNumberPoolbooleanNoTrueWhether 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

json
{
  "numbers": [
    {
      "phoneNumber": "+14155552671",
      "friendlyName": "Sales Line 1",
      "sid": "PN1234567890abcdef1234567890abcde",
      "countryCode": "US",
      "capabilities": {
        "voice": true,
        "sms": true,
        "mms": true,
        "fax": false
      },
      "type": "local",
      "isDefaultNumber": true,
      "linkedUser": "user_123456789",
      "linkedRingAllUsers": [
        "user_123",
        "user_456"
      ],
      "inboundCallService": {
        "type": "voice_ai",
        "value": "68e381b296a83800a27cd1"
      },
      "forwardingNumber": "+14155552672",
      "isGroupConversationEnabled": true,
      "addressSid": "AD1234567890abcdef1234567890abcde",
      "bundleSid": "BU1234567890abcdef1234567890abcde",
      "dateAdded": "2023-01-15T10:30:00Z",
      "dateUpdated": "2023-02-20T14:45:00Z",
      "origin": "twilio"
    },
    {
      "phoneNumber": "+18005551234",
      "friendlyName": "Support Toll-Free",
      "sid": "PN9876543210fedcba9876543210fedcb",
      "countryCode": "US",
      "capabilities": {
        "voice": true,
  // truncado: 26 lineas mas
}
400 - Bad request - Invalid parameters
  • message (string): Example: Invalid locationId format or pagination parameters

  • error (string): Example: Bad Request

  • statusCode (number): Example: 400

json
{
  "message": "Invalid locationId format or pagination parameters",
  "error": "Bad Request",
  "statusCode": 400
}
401 - Unauthorized
json
{}
404 - Phone system not connected
  • message (string): Example: Phone system is not connected to this account

  • statusCode (number): Example: 404

json
{
  "message": "Phone system is not connected to this account",
  "statusCode": 404
}
500 - Internal server error
  • msg (string): Example: Internal server error

  • accountStatus (string): Account status when error occurs Example: suspended

json
{
  "msg": "Internal server error",
  "accountStatus": "suspended"
}

Example

curl -X GET 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?