# List active numbers

GET https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}

List active numbers. With `version: v3`, the HTTP 200 body is the standard success envelope (`status`, `data`, `message`, `statusCode`). The v3 list payload is under `data`; `isUnderGhl` is renamed to `isUnderLc` per AIP naming convention.

## Authentication

Send `Authorization: Bearer <token>` using:

- **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `phonenumbers.read`

## Parameters

### Header Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `Version` | string | Yes | API Version |
| `version` | string | Yes | Send `v3` to use the v3 response contract (AIP). This is the supported version value for these endpoints. |

### Path Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `locationId` | string | Yes | Location ID as string |

### Query Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `pageSize` | number | No | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| `page` | number | No | The page index. The default is 0. |
| `searchFilter` | string | No | Number search Filter |
| `skipNumberPool` | boolean | No | When true, exclude numbers assigned to number pools from the list. |
| `includeRcsSenderIds` | boolean | No | Include RCS Sender IDs |

## OpenAPI Specification

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "LeadConnector API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://services.leadconnectorhq.com"
    }
  ],
  "paths": {
    "/phone-system/numbers/location/{locationId}": {
      "get": {
        "summary": "List active numbers",
        "operationId": "listActiveNumbers",
        "description": "List active numbers. With `version: v3`, the HTTP 200 body is the standard success envelope (`status`, `data`, `message`, `statusCode`). The v3 list payload is under `data`; `isUnderGhl` is renamed to `isUnderLc` per AIP naming convention.",
        "parameters": [
          {
            "name": "Version",
            "in": "header",
            "required": true,
            "description": "API Version",
            "schema": {
              "type": "string",
              "enum": [
                "v3"
              ]
            }
          },
          {
            "name": "locationId",
            "required": true,
            "in": "path",
            "description": "Location ID as string",
            "schema": {
              "type": "string",
              "example": "tDtDnQdgm2LXpyiqYvZ6"
            }
          },
          {
            "name": "pageSize",
            "required": false,
            "in": "query",
            "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
            "schema": {
              "minimum": 1,
              "maximum": 1000,
              "type": "number",
              "example": 50
            }
          },
          {
            "name": "page",
            "required": false,
            "in": "query",
            "description": "The page index. The default is 0.",
            "schema": {
              "minimum": 0,
              "type": "number",
              "example": 0
            }
          },
          {
            "name": "searchFilter",
            "required": false,
            "in": "query",
            "description": "Number search Filter",
            "schema": {
              "type": "string",
              "example": "+91"
            }
          },
          {
            "name": "skipNumberPool",
            "required": false,
            "in": "query",
            "description": "When true, exclude numbers assigned to number pools from the list.",
            "schema": {
              "default": true,
              "type": "boolean",
              "example": true
            }
          },
          {
            "name": "includeRcsSenderIds",
            "required": false,
            "in": "query",
            "description": "Include RCS Sender IDs",
            "schema": {
              "type": "boolean",
              "example": true
            }
          },
          {
            "name": "version",
            "in": "header",
            "description": "Send `v3` to use the v3 response contract (AIP). This is the supported version value for these endpoints.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "v3"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success envelope; v3 list details are in `data` (including `isUnderLc` instead of legacy `isUnderGhl`).",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListNumbersV3Http200ResponseDto"
                }
              }
            }
          }
        },
        "security": [
          {
            "Location-Access": [
              "phonenumbers.read"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
        "type": "http"
      },
      "Location-Access": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.",
        "type": "http"
      },
      "Location-Access-Only": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Sub-Account.",
        "type": "http"
      },
      "Agency-Access": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.",
        "type": "http"
      },
      "Agency-Access-Only": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "name": "Authorization",
        "in": "header",
        "description": "Use the Access Token generated with user type as Agency.",
        "type": "http"
      }
    },
    "schemas": {
      "ListNumbersV3Http200ResponseDto": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Outcome indicator from the shared success helper.",
            "example": "success",
            "enum": [
              "success"
            ]
          },
          "data": {
            "description": "V3 list payload: numbers, pagination fields, isUnderLc (renamed from isUnderGhl), etc.",
            "example": {
              "numbers": [
                {
                  "phoneNumber": "+17745678902",
                  "friendlyName": "Main line",
                  "countryCode": "US"
                }
              ],
              "isUnderLc": true,
              "pageSize": 50,
              "page": 0,
              "accountStatus": "active",
              "total": 1
            },
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "numbers": {
                    "description": "Active numbers available for the location",
                    "example": [
                      {
                        "phoneNumber": "+17745678902",
                        "friendlyName": "Main line",
                        "sid": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                        "countryCode": "US",
                        "capabilities": {
                          "voice": true,
                          "sms": true,
                          "mms": true,
                          "fax": false
                        },
                        "type": "local",
                        "isDefaultNumber": true
                      }
                    ],
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "phoneNumber": {
                          "type": "string",
                          "description": "Phone number in E.164 format",
                          "example": "+17745678902"
                        },
                        "friendlyName": {
                          "type": "string",
                          "description": "Human-friendly label for the number",
                          "example": "Main line"
                        },
                        "sid": {
                          "type": "string",
                          "description": "Provider number identifier",
                          "example": "PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
                        },
                        "countryCode": {
                          "type": "string",
                          "description": "ISO country code for the number",
                          "example": "US"
                        },
                        "capabilities": {
                          "description": "Phone number capabilities",
                          "example": {
                            "voice": true,
                            "sms": true,
                            "mms": true,
                            "fax": false
                          },
                          "allOf": [
                            {
                              "type": "object",
                              "properties": {
                                "voice": {
                                  "type": "boolean",
                                  "description": "Whether the number supports voice calls",
                                  "example": true
                                },
                                "sms": {
                                  "type": "boolean",
                                  "description": "Whether the number supports SMS",
                                  "example": true
                                },
                                "mms": {
                                  "type": "boolean",
                                  "description": "Whether the number supports MMS",
                                  "example": true
                                },
                                "fax": {
                                  "type": "boolean",
                                  "description": "Whether the number supports fax",
                                  "example": false
                                }
                              },
                              "title": "NumberCapabilitiesDto"
                            }
                          ]
                        },
                        "type": {
                          "type": "string",
                          "description": "Phone number type",
                          "example": "local"
                        },
                        "isDefaultNumber": {
                          "type": "boolean",
                          "description": "Whether this is the default outbound number",
                          "example": true
                        },
                        "linkedUser": {
                          "type": "string",
                          "description": "Linked user ID if the number is assigned",
                          "example": "user-123",
                          "nullable": true
                        },
                        "linkedRingAllUsers": {
                          "description": "Ring-all user IDs linked to the number",
                          "example": [
                            "user-123",
                            "user-456"
                          ],
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "inboundCallService": {
                          "type": "object",
                          "description": "Inbound call service metadata",
                          "additionalProperties": true,
                          "example": {
                            "type": "ivr",
                            "value": "flow-123"
                          }
                        },
                        "forwardingNumber": {
                          "type": "string",
                          "description": "Forwarding number in E.164 format",
                          "example": "+17745678903"
                        },
                        "isGroupConversationEnabled": {
                          "type": "boolean",
                          "description": "Whether group conversations are enabled",
                          "example": true
                        },
                        "addressSid": {
                          "type": "string",
                          "description": "Address SID used for regulated number purchases",
                          "example": "ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
                        },
                        "bundleSid": {
                          "type": "string",
                          "description": "Bundle SID used for regulated number purchases",
                          "example": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
                        },
                        "dateAdded": {
                          "type": "object",
                          "description": "Date the number was added",
                          "example": "2024-01-01T00:00:00.000Z"
                        },
                        "dateUpdated": {
                          "type": "object",
                          "description": "Date the number was last updated",
                          "example": "2024-01-01T00:00:00.000Z"
                        },
                        "dateCreated": {
                          "type": "object",
                          "description": "Legacy created-at field returned by some providers",
                          "example": "2024-01-01T00:00:00.000Z"
                        },
                        "origin": {
                          "type": "string",
                          "description": "Provider origin for the number",
                          "example": "twilio"
                        }
                      },
                      "required": [
                        "phoneNumber"
                      ],
                      "title": "ListNumberItemResponseDto"
                    }
                  },
                  "isUnderLc": {
                    "type": "boolean",
                    "description": "Whether the account is managed under LC. Renamed from isUnderGhl.",
                    "example": true
                  },
                  "pageSize": {
                    "type": "number",
                    "description": "The page size requested",
                    "example": 50
                  },
                  "page": {
                    "type": "number",
                    "description": "The zero-based page index requested",
                    "example": 0
                  },
                  "accountStatus": {
                    "type": "string",
                    "description": "Twilio account status for the location",
                    "example": "active"
                  },
                  "rcsSenderIds": {
                    "description": "Optional RCS sender IDs returned with the number list",
                    "example": [
                      {
                        "number": "rcs-sender-id",
                        "numberType": "rcsSenderId",
                        "friendlyName": "Brand Sender",
                        "rcsMeta": {
                          "brandId": "brand-123"
                        }
                      }
                    ],
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "number": {
                          "type": "string",
                          "description": "RCS sender ID",
                          "example": "rcs-sender-id"
                        },
                        "numberType": {
                          "type": "string",
                          "description": "Entry type",
                          "example": "rcsSenderId"
                        },
                        "friendlyName": {
                          "type": "string",
                          "description": "Human-friendly label for the sender ID",
                          "example": "Brand Sender"
                        },
                        "rcsMeta": {
                          "type": "object",
                          "description": "RCS sender metadata",
                          "additionalProperties": true,
                          "example": {
                            "brandId": "brand-123"
                          }
                        }
                      },
                      "required": [
                        "number",
                        "numberType"
                      ],
                      "title": "RcsSenderIdResponseDto"
                    }
                  },
                  "total": {
                    "type": "number",
                    "description": "Total number of active numbers when available",
                    "example": 2
                  }
                },
                "required": [
                  "numbers"
                ],
                "title": "ListNumbersV3ResponseDto"
              }
            ]
          },
          "message": {
            "type": "string",
            "description": "Human-readable success message.",
            "example": "OK"
          },
          "statusCode": {
            "type": "number",
            "description": "HTTP status echoed in the response body.",
            "example": 200
          }
        },
        "required": [
          "status",
          "data",
          "message",
          "statusCode"
        ],
        "title": "ListNumbersV3Http200ResponseDto"
      }
    }
  }
}
```

## Code Examples

**cURL**

```bash
curl -L -X GET 'https://services.leadconnectorhq.com/phone-system/numbers/location/<locationId>' \
  -H 'Authorization: Bearer <TOKEN>' \
  -H 'Version: v3'
```

**Node.js**

```javascript
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <TOKEN>',
    Version: 'v3'
  }
};

try {
  const response = await fetch('https://services.leadconnectorhq.com/phone-system/numbers/location/<locationId>', options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

**Python**

```python
import requests

url = "https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}"

headers = {
    "Authorization": "Bearer <TOKEN>",
    "Version": "v3"
}

response = requests.get(url, headers=headers)
print(response.json())
```

**PHP**

```php
<?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://services.leadconnectorhq.com/phone-system/numbers/location/<locationId>',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Version: v3',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;
```

**Java**

```java
HttpResponse<String> response = Unirest
  .get("https://services.leadconnectorhq.com/phone-system/numbers/location/<locationId>")
  .header("Authorization", "Bearer <TOKEN>")
  .header("Version", "v3")
  .asString();
```

**Go**

```go
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {
  url := "https://services.leadconnectorhq.com/phone-system/numbers/location/<locationId>"
  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "Bearer <TOKEN>")
  req.Header.Add("Version", "v3")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}
```

**Ruby**

```ruby
require 'uri'
require 'net/http'

url = URI("https://services.leadconnectorhq.com/phone-system/numbers/location/<locationId>")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer <TOKEN>"
request["Version"] = "v3"

response = http.request(request)
puts response.read_body
```

**PowerShell**

```powershell
$headers = @{
  "Authorization" = "Bearer <TOKEN>"
  "Version" = "v3"
}

$response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/phone-system/numbers/location/<locationId>' -Method 'GET' -Headers $headers
$response | ConvertTo-Json
```