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

# List Organization Phone Numbers

> List all phone numbers in your organization.

Returns phone numbers with their assignment status and assistant information.
By default, only active phone numbers are returned.

This endpoint retrieves a list of all phone numbers belonging to your organization. It includes information about each number's assignment status.

### Query Parameters

* `include_assigned` (boolean, optional, default: true): Set to `false` to exclude numbers that are currently assigned to an assistant.
* `include_unassigned` (boolean, optional, default: true): Set to `false` to exclude numbers that are not currently assigned to any assistant.
* `include_inactive` (boolean, optional, default: false): Set to `true` to include inactive or deactivated numbers.

### Response

The response is a JSON array of phone number objects. If a number is assigned, the `assistant` field will contain details about the assistant it's linked to.

```json Response theme={null}
[
  {
    "id": 1,
    "phone_number": "+15551234567",
    "friendly_name": "Main Support Line",
    "provider": "twilio",
    "twilio_sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "is_active": true,
    "is_verified_caller_id": false,
    "capabilities": { "voice": true, "sms": true, "mms": true },
    "sip_trunk_id": null,
    "allowed_country_codes": null,
    "assistant": {
      "id": 123,
      "name": "Customer Service Bot",
      "is_active": true
    },
    "flow": null,
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-26T11:00:00Z"
  },
  {
    "id": 2,
    "phone_number": "+15557654321",
    "friendly_name": "Sales Department",
    "provider": "telnyx",
    "twilio_sid": "PNyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
    "is_active": true,
    "is_verified_caller_id": false,
    "capabilities": { "voice": true, "sms": false, "mms": false },
    "sip_trunk_id": null,
    "allowed_country_codes": null,
    "assistant": null,
    "flow": null,
    "created_at": "2023-10-02T12:00:00Z",
    "updated_at": null
  }
]
```


## OpenAPI

````yaml GET /api/v1/assistants/organization/phone-numbers
openapi: 3.1.0
info:
  title: Burki
  description: A system that uses AI to answer customer Calls.
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/assistants/organization/phone-numbers:
    get:
      tags:
        - assistants
      summary: List Organization Phone Numbers
      description: >-
        List all phone numbers in your organization.


        Returns phone numbers with their assignment status and assistant
        information.

        By default, only active phone numbers are returned.
      operationId: >-
        list_organization_phone_numbers_api_v1_assistants_organization_phone_numbers_get
      parameters:
        - name: include_assigned
          in: query
          required: false
          schema:
            type: boolean
            description: Include phone numbers assigned to assistants
            default: true
            title: Include Assigned
          description: Include phone numbers assigned to assistants
        - name: include_unassigned
          in: query
          required: false
          schema:
            type: boolean
            description: Include unassigned phone numbers
            default: true
            title: Include Unassigned
          description: Include unassigned phone numbers
        - name: include_inactive
          in: query
          required: false
          schema:
            type: boolean
            description: Include inactive/deactivated phone numbers
            default: false
            title: Include Inactive
          description: Include inactive/deactivated phone numbers
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrganizationPhoneNumberResponse'
                title: >-
                  Response List Organization Phone Numbers Api V1 Assistants
                  Organization Phone Numbers Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    OrganizationPhoneNumberResponse:
      properties:
        id:
          type: integer
          title: Id
        phone_number:
          type: string
          title: Phone Number
        friendly_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Friendly Name
        provider:
          type: string
          title: Provider
        twilio_sid:
          type: string
          title: Twilio Sid
        is_active:
          type: boolean
          title: Is Active
        is_verified_caller_id:
          type: boolean
          title: Is Verified Caller Id
          default: false
        capabilities:
          additionalProperties:
            type: boolean
          type: object
          title: Capabilities
        sip_trunk_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Sip Trunk Id
        allowed_country_codes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Allowed Country Codes
        assistant:
          anyOf:
            - $ref: '#/components/schemas/OrganizationAssistantInfo'
            - type: 'null'
        flow:
          anyOf:
            - $ref: '#/components/schemas/OrganizationFlowInfo'
            - type: 'null'
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - phone_number
        - provider
        - twilio_sid
        - is_active
        - capabilities
        - created_at
      title: OrganizationPhoneNumberResponse
      description: Response model for listing organization phone numbers.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrganizationAssistantInfo:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
        - id
        - name
        - is_active
      title: OrganizationAssistantInfo
      description: Minimal assistant info for phone number list.
    OrganizationFlowInfo:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
        - id
        - name
        - is_active
      title: OrganizationFlowInfo
      description: ConversationFlow information for phone number responses.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````