> ## Documentation Index
> Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Active Numbers

> Retrieve a paginated list of active phone numbers for a specific location



## OpenAPI

````yaml /api-reference/phone-system/openapi.json get /phone-system/numbers/location/{locationId}
openapi: 3.0.0
info:
  title: Phone System API
  description: Documentation for Phone System API
  version: '1.0'
  contact: {}
servers:
  - url: https://services.leadconnectorhq.com
security: []
tags:
  - name: Phone Numbers
    description: Manage active phone numbers for a location
  - name: Number Pools
    description: Manage number pools for call routing
paths:
  /phone-system/numbers/location/{locationId}:
    get:
      tags:
        - Phone Numbers
      summary: List Active Numbers
      description: >-
        Retrieve a paginated list of active phone numbers for a specific
        location
      operationId: active-numbers
      parameters:
        - name: locationId
          in: path
          description: The unique identifier of the location
          required: true
          schema:
            type: string
          example: ve9EPM428h8vShlRW1KT
        - name: pageSize
          in: query
          description: Number of results per page (max 1000)
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 1000
            default: 1000
        - name: page
          in: query
          description: Page index (0-based)
          required: false
          schema:
            type: number
            minimum: 0
            default: 0
        - name: searchFilter
          in: query
          description: Filter numbers by phone number pattern (e.g., "+91")
          required: false
          schema:
            type: string
        - name: skipNumberPool
          in: query
          description: Exclude numbers assigned to number pools
          required: false
          schema:
            type: boolean
            default: true
        - name: Version
          in: header
          description: API Version
          required: true
          schema:
            type: string
            enum:
              - '2021-07-28'
      responses:
        '200':
          description: Successfully retrieved list of active numbers
          content:
            application/json:
              schema:
                type: object
                properties:
                  numbers:
                    type: array
                    items:
                      $ref: '#/components/schemas/DetailedPhoneNumberDto'
                  pageSize:
                    type: number
                  page:
                    type: number
                  accountStatus:
                    type: string
                    enum:
                      - active
                      - suspended
                      - closed
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Phone system not connected
        '500':
          description: Internal server error
      security:
        - bearer:
            - phonenumbers.read
components:
  schemas:
    DetailedPhoneNumberDto:
      type: object
      properties:
        phoneNumber:
          type: string
          example: '+14155552671'
        friendlyName:
          type: string
          example: Sales Line 1
          nullable: true
        sid:
          type: string
          example: PN1234567890abcdef
        countryCode:
          type: string
          example: US
        capabilities:
          type: object
          properties:
            voice:
              type: boolean
            sms:
              type: boolean
            mms:
              type: boolean
            fax:
              type: boolean
        type:
          type: string
          enum:
            - local
            - toll-free
            - mobile
            - national
        isDefaultNumber:
          type: boolean
        linkedUser:
          type: string
          nullable: true
        forwardingNumber:
          type: string
          nullable: true
        isGroupConversationEnabled:
          type: boolean
        dateAdded:
          type: string
          format: date-time
        dateUpdated:
          type: string
          format: date-time
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access Token or Private Integration Token

````