Get list of number pools

http
GET https://services.leadconnectorhq.com/phone-system/number-pools

Authorization

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

Query parameters

NameTypeRequiredExampleDescription
locationIdstringNove9EPM428h8vShlRW1KTAccount ID to filter pools

Responses

200 - Successfully retrieved number pools list
  • success (boolean): Indicates if the request was successful Example: True

  • data (object[]): Array of number pool objects

    • id (string): Unique identifier for the number pool Example: ve9EPM428h8vShlRW1KT

    • name (string): Human-readable name of the number pool Example: Sales Team Pool

    • locationId (string): Account ID this pool belongs to Example: loc123

    • numbers (object[]): Phone numbers in this pool

      • phoneNumber (string): E.164 formatted phone number Example: +14155552671

      • friendlyName (string): Human-readable name for the number Example: Sales Line 1

    • forwardingNumber (string): Number to forward calls to Example: +14155552671

    • whisper (boolean): Whether whisper is enabled Example: True

    • whisperMessage (string): Message played during whisper Example: Incoming call from sales line

    • callRecording (boolean): Whether call recording is enabled Example: True

    • isActive (boolean): Whether the number pool is active Example: True

    • inboundCallService (object): Inbound call service configuration

      • type (string): Type of inbound call service Example: voice_ai

      • value (string): Service configuration value/ID Example: 68e381b296a83800a27cd1

  • total (number): Total number of pools returned Example: 5

json
{
  "success": true,
  "data": [
    {
      "id": "ve9EPM428h8vShlRW1KT",
      "name": "Sales Team Pool",
      "locationId": "loc123",
      "numbers": [
        {
          "phoneNumber": "+14155552671",
          "friendlyName": "Sales Line 1"
        }
      ],
      "forwardingNumber": "+14155552671",
      "whisper": true,
      "whisperMessage": "Incoming call from sales line",
      "callRecording": true,
      "isActive": true,
      "inboundCallService": {
        "type": "voice_ai",
        "value": "68e381b296a83800a27cd1"
      }
    }
  ],
  "total": 1
}
400 - Bad request - Invalid account ID or parameters
  • message (string): Example: Invalid locationId format

  • error (string): Example: Bad Request

  • statusCode (number): Example: 400

json
{
  "message": "Invalid locationId format",
  "error": "Bad Request",
  "statusCode": 400
}
401 - Unauthorized - Invalid or missing authentication token
403 - Forbidden - Insufficient permissions for this account

Example

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

Last updated October 26, 2026

Was this page helpful?