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

# List available numbers

> Browse purchasable India pool inventory with per-number cost.

Query params:

| Param             | Default                               | Notes                                  |
| ----------------- | ------------------------------------- | -------------------------------------- |
| `country`         | Tenant billing country (usually `IN`) | ISO country filter                     |
| `limit`           | `150` (max `300`)                     | Page size                              |
| `concurrentCalls` | `0`                                   | Included in each row's `cost` when > 0 |

```json theme={"system"}
{
  "numbers": [
    {
      "id": "66f...",
      "number": "+91xxxxxxxxxx",
      "country": "IN",
      "countryName": "India",
      "cost": 7
    }
  ],
  "country": "IN",
  "limit": 20,
  "pricingNote": "Cost is per number in account credits (USD). Concurrent slots add to cost when concurrentCalls > 0."
}
```

Empty `numbers: []` means pool inventory is exhausted for that country — purchase is not possible until inventory is restocked. Twilio/Telnyx search is not on this route (`422 pool_purchase_unavailable` when the tenant cannot buy pool).

Next: [Purchase numbers](/api-reference/endpoint/inbound-agents/purchase-numbers).


## OpenAPI

````yaml openapi.json GET /api/v1/numbers/available
openapi: 3.0.3
info:
  title: Ondial Public API
  version: 1.0.0
  description: >-
    Tenant API-key surface for lead ingest, contacts (including dial
    conversation + analysis), events, inbound agents, company profiles, and
    knowledge-base documents.


    **Campaign definition is UI-only** — create and start an API-ingest campaign
    in the dashboard, then push leads here.


    **Auth:** `Authorization: Bearer ond_live_…` or `ond_test_…` (or
    `X-API-Key`). Keys are requested in **API Access** with a friendly **key
    name**, then approved by Super Admin (not self-serve). Tenants can rename
    keys later without rotating the secret.


    **Scopes:** Company and knowledge-base routes require opt-in scopes
    (`companies:read`, `companies:write`, `knowledge:read`, `knowledge:write`)
    granted at key approval. Missing scope → `403 forbidden`.


    **Sandbox** keys never place PSTN dials or live WhatsApp/email and do not
    burn credits (KB upload skips debit).


    **Security:** Company responses never include SMTP/WhatsApp credentials. KB
    v1 is metadata-only — no file download.


    **Kill switch:** Super Admin can disable all `/api/v1/*` (`503` /
    `api_globally_disabled`) without stopping UI CSV campaigns.


    **Compliance:** Call channel requires `consent.outboundCall: true` and phone
    not on tenant/platform DNC.
servers:
  - url: https://dashboard.ondial.ai
    description: Production
  - url: http://localhost:3001
    description: Local
security:
  - BearerAuth: []
tags:
  - name: Core
    description: Auth check and lead ingest
  - name: Contacts
    description: Status, dials/conversation/analysis, cancel, delete, follow-ups, list
  - name: Events
    description: ERP event bus slice — eventType → campaign
  - name: Outbound
    description: >-
      Read-only campaign lookup for API / Custom CRM. Create and start campaigns
      in the dashboard.
  - name: Inbound agents
    description: Configure inbound agents; list/buy pool numbers; read credits
  - name: Companies
    description: >-
      Company profile CRUD (requires companies:read / companies:write scopes).
      Never returns SMTP or WhatsApp credentials.
  - name: Knowledge bases
    description: >-
      Knowledge document upload/list/delete (requires knowledge:read /
      knowledge:write scopes). Metadata only — no file download via API.
paths:
  /api/v1/numbers/available:
    get:
      tags:
        - Inbound agents
      summary: List available pool numbers
      description: >-
        Purchasable India pool inventory with per-number cost in account
        credits. Empty array means inventory is exhausted for that country.
      operationId: listAvailableNumbers
      parameters:
        - in: query
          name: country
          required: false
          schema:
            type: string
            default: IN
          description: ISO country filter (defaults to tenant billing country)
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            default: 150
            maximum: 300
          description: Max rows to return
        - in: query
          name: concurrentCalls
          required: false
          schema:
            type: integer
            default: 0
          description: Included in each row cost when greater than 0
      responses:
        '200':
          description: Available pool numbers
          content:
            application/json:
              schema:
                type: object
                properties:
                  numbers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        number:
                          type: string
                        country:
                          type: string
                        countryName:
                          type: string
                        flagEmoji:
                          type: string
                        cost:
                          type: number
                  country:
                    type: string
                  limit:
                    type: integer
                  pricingNote:
                    type: string
              example:
                numbers:
                  - id: 66f0123456789abcdef01234
                    number: '+919876543210'
                    country: IN
                    countryName: India
                    flagEmoji: 🇮🇳
                    cost: 7
                country: IN
                limit: 20
                pricingNote: >-
                  Cost is per number in account credits (USD). Concurrent slots
                  add to cost when concurrentCalls > 0.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          description: Pool purchase unavailable for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              example:
                error: >-
                  Pool inventory is not available for this account. Use Twilio
                  purchase flow.
                reasonCode: pool_purchase_unavailable
                numbers: []
components:
  responses:
    Unauthorized:
      description: Missing, invalid, or inactive API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            error: Invalid or inactive API key
            reasonCode: unauthorized
  schemas:
    ErrorBody:
      type: object
      properties:
        error:
          type: string
        reasonCode:
          type: string
        missing:
          type: array
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ond_live | ond_test
      description: >-
        Paste only your API key (`ond_live_…` or `ond_test_…`). Do not type the
        word Bearer — the playground adds it.

````