Telnyx Phone Number Search API

Number search

GitHub OpenAPI
Business capability
Numbering Resource Management BC-2640.30

Operations 2

GET /available_phone_number_blocks List available phone number blocks #
GET /available_phone_numbers List available phone numbers #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-phone-number-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telnyx-phone-number-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Telnyx Phone Number Search API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Phone Number Search across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Phone Number Search
  description: Number search
paths:
  /available_phone_number_blocks:
    get:
      summary: List available phone number blocks
      operationId: ListAvailablePhoneNumberBlocks
      tags:
      - Phone Number Search
      parameters:
      - name: filter
        in: query
        style: deepObject
        explode: true
        description: 'Consolidated filter parameter (deepObject style). Originally: filter[locality], filter[country_code], filter[national_destination_code], filter[phone_number_type]'
        schema:
          type: object
          properties:
            locality:
              type: string
              description: Filter phone numbers by city.
            country_code:
              type: string
              description: Filter phone numbers by country.
            national_destination_code:
              type: string
              description: Filter by the national destination code of the number.
            phone_number_type:
              type: string
              enum:
              - local
              - toll_free
              - mobile
              - national
              - shared_cost
              description: Filter phone numbers by number type.
      responses:
        '200':
          description: Successful response with a list of available phone numbers blocks.
          content:
            application/json:
              schema:
                type: object
                title: List Available Phone Numbers Blocks Response
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AvailablePhoneNumberBlock'
                  meta:
                    $ref: '#/components/schemas/AvailablePhoneNumbersMetadata'
        '400':
          $ref: '#/components/responses/numbers_BadRequestResponse_73c9788e53'
        '401':
          $ref: '#/components/responses/numbers_UnauthorizedResponse_73c9788e53'
        '404':
          $ref: '#/components/responses/numbers_NotFoundResponse_73c9788e53'
        '422':
          $ref: '#/components/responses/numbers_UnprocessableEntity_73c9788e53'
        '500':
          $ref: '#/components/responses/GenericErrorResponse'
      description: Searches the Telnyx inventory for available contiguous phone-number blocks. Results can be filtered by locality, country, national destination code, and number type.
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /available_phone_numbers:
    get:
      summary: List available phone numbers
      operationId: ListAvailablePhoneNumbers
      tags:
      - Phone Number Search
      x-group-parameters: 'true'
      x-endpoint-cost: heavy
      parameters:
      - name: filter
        in: query
        style: deepObject
        explode: true
        description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[locality], filter[administrative_area], filter[country_code], filter[national_destination_code], filter[rate_center], filter[phone_number_type], filter[features], filter[limit], filter[best_effort], filter[quickship], filter[reservable], filter[exclude_held_numbers]'
        schema:
          type: object
          properties:
            phone_number:
              type: object
              description: Filter phone numbers by pattern matching.
              properties:
                starts_with:
                  type: string
                  description: Filter numbers starting with a pattern (excludes NDC if used with `national_destination_code` filter).
                ends_with:
                  type: string
                  description: Filter numbers ending with a pattern (excludes NDC if used with `national_destination_code` filter).
                contains:
                  type: string
                  description: Filter numbers containing a pattern (excludes NDC if used with `national_destination_code` filter).
              additionalProperties: false
            locality:
              type: string
              description: Filter phone numbers by city.
            administrative_area:
              type: string
              description: Find numbers in a particular US state or CA province.
            country_code:
              type: string
              description: Filter phone numbers by country.
            national_destination_code:
              type: string
              description: Filter by the national destination code of the number.
            rate_center:
              type: string
              description: Filter phone numbers by rate center. This filter is only applicable to USA and Canada numbers.
            phone_number_type:
              type: string
              enum:
              - local
              - toll_free
              - mobile
              - national
              - shared_cost
              description: Filter phone numbers by number type.
            features:
              type: array
              items:
                type: string
                enum:
                - sms
                - mms
                - voice
                - fax
                - emergency
                - hd_voice
                - international_sms
                - local_calling
              description: Filter phone numbers with specific features.
            limit:
              type: integer
              description: Limits the number of results.
            best_effort:
              type: boolean
              description: Filter to determine if best effort results should be included. Only available in USA/CANADA.
            quickship:
              type: boolean
              description: Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.
            reservable:
              type: boolean
              description: Filter to ensure only numbers that can be reserved are included in the results.
            exclude_held_numbers:
              type: boolean
              description: Filter to exclude phone numbers that are currently on hold/reserved for your account.
      responses:
        '200':
          description: Successful response with a list of available phone numbers.
          content:
            application/json:
              schema:
                type: object
                title: List Available Phone Numbers Response
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AvailablePhoneNumber'
                  meta:
                    $ref: '#/components/schemas/AvailablePhoneNumbersMetadata'
                  metadata:
                    $ref: '#/components/schemas/AvailablePhoneNumbersMetadata'
        '400':
          $ref: '#/components/responses/numbers_BadRequestResponse_73c9788e53'
        '401':
          $ref: '#/components/responses/numbers_UnauthorizedResponse_73c9788e53'
        '404':
          $ref: '#/components/responses/numbers_NotFoundResponse_73c9788e53'
        '422':
          $ref: '#/components/responses/numbers_UnprocessableEntity_73c9788e53'
        '500':
          $ref: '#/components/responses/GenericErrorResponse'
      description: Searches the Telnyx inventory for available phone numbers. Filters support number patterns, location, number type, features, reservability, and other inventory constraints; the response includes matching numbers and search metadata.
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    AvailablePhoneNumber:
      type: object
      properties:
        record_type:
          type: string
          example: available_phone_number
          enum:
          - available_phone_number
        phone_number:
          type: string
          example: '+19705555098'
        vanity_format:
          type: string
        best_effort:
          type: boolean
          description: Specifies whether the phone number is an exact match based on the search criteria or not.
          example: false
        quickship:
          type: boolean
          description: Specifies whether the phone number can receive calls immediately after purchase or not.
          example: true
        reservable:
          type: boolean
          description: Specifies whether the phone number can be reserved before purchase or not.
          example: true
        region_information:
          type: array
          items:
            $ref: '#/components/schemas/RegionInformation'
        cost_information:
          $ref: '#/components/schemas/CostInformation'
        features:
          type: array
          items:
            $ref: '#/components/schemas/Feature'
      example:
        record_type: available_phone_number
        phone_number: '+19705555098'
        vanity_format: ''
        best_effort: false
        quickship: true
        reservable: true
        region_information:
        - region_type: country_code
          region_name: US
        cost_information:
          upfront_cost: '3.21'
          monthly_cost: '6.54'
          currency: USD
        features:
        - name: sms
        - name: voice
    RegionInformation:
      properties:
        region_type:
          type: string
          example: country_code
          enum:
          - country_code
          - rate_center
          - state
          - location
        region_name:
          type: string
          example: US
      example:
        region_type: country_code
        region_name: US
      type: object
    AvailablePhoneNumbersMetadata:
      type: object
      example:
        total_results: 100
        best_effort_results: 50
      properties:
        total_results:
          type: integer
          example: 1
        best_effort_results:
          type: integer
          example: 0
    CostInformation:
      type: object
      properties:
        upfront_cost:
          type: string
          example: '3.21'
        monthly_cost:
          type: string
          example: '6.54'
        currency:
          type: string
          description: The ISO 4217 code for the currency.
          example: USD
      example:
        upfront_cost: '3.21'
        monthly_cost: '6.54'
        currency: USD
    billing-group_Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties: {}
          additionalProperties: true
    AvailablePhoneNumberBlock:
      type: object
      properties:
        record_type:
          type: string
          example: available_phone_number_block
          enum:
          - available_phone_number_block
        phone_number:
          type: string
          example: '+19705555000'
        range:
          type: integer
          example: 10
        region_information:
          type: array
          items:
            $ref: '#/components/schemas/RegionInformation'
        cost_information:
          $ref: '#/components/schemas/CostInformation'
        features:
          type: array
          items:
            $ref: '#/components/schemas/Feature'
      example:
        record_type: available_phone_number_block
        phone_number: '+19705555000'
        range: 10
        region_information:
        - region_type: country_code
          region_name: US
        cost_information:
          upfront_cost: '3.21'
          monthly_cost: '6.54'
          currency: USD
        features:
        - name: sms
        - name: voice
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/billing-group_Error'
      type: object
    Feature:
      properties:
        name:
          type: string
          example: sms
      example:
        name: sms
      type: object
    numbers_Error:
      properties:
        code:
          example: '10007'
          type: string
        detail:
          example: An unexpected error occured.
          type: string
        meta:
          properties:
            url:
              description: URL with additional information on the error.
              example: https://developers.telnyx.com/docs/overview/errors/10015
              type: string
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              example: /base
              type: string
          type: object
        title:
          example: Unexpected error
          type: string
      type: object
    numbers_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/numbers_Error'
          type: array
      type: object
    Errors_2:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
          x-format: int64
        title:
          type: string
        detail:
          type: string
          description: A human-readable explanation of the error.
        description:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      example:
        title: Invalid street address
        source:
          pointer: /street_address
        code: '20207'
        description: The street address provided is invalid.
      type: object
  responses:
    numbers_UnauthorizedResponse_73c9788e53:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          examples:
            Authentication Failed:
              value:
                errors:
                - code: '10009'
                  title: Authentication failed
                  detail: Could not understand the provided credentials.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10009
    numbers_UnprocessableEntity_73c9788e53:
      description: Unprocessable entity. Check the 'detail' field in response for details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    numbers_NotFoundResponse_73c9788e53:
      description: The requested resource doesn't exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    numbers_BadRequestResponse_73c9788e53:
      description: Bad request, the request was unacceptable, often due to missing a required parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    GenericErrorResponse:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
    ListAvailablePhoneNumbersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/AvailablePhoneNumber'
                type: array
              meta:
                $ref: '#/components/schemas/AvailablePhoneNumbersMetadata'
              metadata:
                $ref: '#/components/schemas/AvailablePhoneNumbersMetadata'
            title: List Available Phone Numbers Response
            type: object
      description: Successful response with a list of available phone numbers.
    numbers_UnauthorizedResponse:
      content:
        application/json:
          examples:
            Authentication Failed:
              value:
                errors:
                - code: '10009'
                  detail: Could not understand the provided credentials.
                  meta:
                    url: https://developers.telnyx.com/docs/overview/errors/10009
                  title: Authentication failed
          schema:
            $ref: '#/components/schemas/numbers_Errors'
      description: Unauthorized
    numbers_GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
      description: Unexpected error
    numbers_BadRequestResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
      description: Bad request, the request was unacceptable, often due to missing a required parameter.
    ListAvailablePhoneNumbersBlockResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/AvailablePhoneNumberBlock'
                type: array
              meta:
                $ref: '#/components/schemas/AvailablePhoneNumbersMetadata'
            title: List Available Phone Numbers Blocks Response
            type: object
      description: Successful response with a list of available phone numbers blocks.
    numbers_NotFoundResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
      description: The requested resource doesn't exist.
    numbers_UnprocessableEntity:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/numbers_Errors'
      description: Unprocessable entity. Check the 'detail' field in response for details.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt