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/simple-ai:simple-ai-numbers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Public API v1 Numbers API
  description: 'Public API v1 requiring API keys.


    **Timestamps:** All datetime fields in API responses are returned in UTC using ISO 8601 format (e.g., `2024-01-15T14:30:00Z`). When filtering by date parameters, provide timestamps in ISO 8601 format.'
  version: 0.1.0
servers:
- url: https://api.usesimple.ai/api/v1
  description: Production API Server
tags:
- name: Numbers
paths:
  /numbers:
    get:
      tags:
      - Numbers
      summary: List Numbers
      description: List all phone numbers associated with the organization.
      operationId: list_numbers_numbers_get
      security:
      - APIKeyHeader: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PhoneNumberResponse'
  /numbers/{uuid}:
    get:
      tags:
      - Numbers
      summary: Get Number Details
      description: Get details for a specific phone number.
      operationId: get_number_details_numbers__uuid__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberResponse'
        '404':
          description: Number Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
    patch:
      tags:
      - Numbers
      summary: Update Number
      description: Update the friendly name of a phone number.
      operationId: update_number_numbers__uuid__patch
      security:
      - APIKeyHeader: []
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                friendly_name:
                  type: string
                  title: Friendly Name
                  description: The new friendly name for the phone number
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberResponse'
        '404':
          description: Number Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
    delete:
      tags:
      - Numbers
      summary: Delete Number
      description: Release and delete a phone number. This releases the number from Twilio and removes it from your account. This operation cannot be undone.
      operationId: delete_number_numbers__uuid__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Uuid
      responses:
        '200':
          description: Number Deleted Successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    default: true
                  message:
                    type: string
                    description: Success message
                required:
                - success
                - message
        '404':
          description: Number Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    default: Phone number not found
        '422':
          description: Deletion Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    default: false
                  error:
                    type: string
                    description: Error message describing why the deletion failed
  /numbers/search_available:
    get:
      tags:
      - Numbers
      summary: Search Available Numbers
      description: Search for available phone numbers to purchase.
      operationId: search_available_numbers_numbers_search_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: area_code
        in: query
        required: false
        schema:
          type: string
          title: Area Code
      - name: country
        in: query
        required: false
        schema:
          type: string
          title: Country
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AvailableNumberResponse'
  /numbers/buy_number:
    post:
      tags:
      - Numbers
      summary: Buy Number
      description: Purchase a phone number.
      operationId: buy_number_numbers_buy_post
      security:
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - phone_number
              properties:
                phone_number:
                  type: string
                  title: Phone Number
                  description: The phone number to purchase
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberResponse'
        '422':
          description: Purchase Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
  /numbers/{uuid}/assign_agent:
    post:
      tags:
      - Numbers
      summary: Assign Agent to Number
      description: Assign an agent to handle calls for a specific phone number.
      operationId: assign_agent_numbers__uuid__assign_agent_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - agent_uuid
              properties:
                agent_uuid:
                  type: string
                  format: uuid
                  title: Agent UUID
                  description: The UUID of the agent to assign
                version_id:
                  type: string
                  format: uuid
                  title: Version Id
                  description: When assigning an agent, specifies which agent version to use. If not provided, uses the most recently updated version.
                  examples:
                  - 456e7890-e89b-12d3-a456-426614174000
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Number or Agent Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
components:
  schemas:
    AvailableNumberResponse:
      type: object
      properties:
        phone_number:
          type: string
        friendly_name:
          type: string
        address_requirements:
          type: string
        region:
          type: string
        country:
          type: string
      required:
      - phone_number
      - friendly_name
      - address_requirements
      - region
      - country
      title: AvailableNumberResponse
    PhoneNumberResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type: string
        friendly_name:
          type: string
        area_code:
          type: string
        country:
          type: string
        agent:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            uuid:
              type: string
              format: uuid
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - id
      - number
      - friendly_name
      - area_code
      - country
      - status
      - active
      - created_at
      - updated_at
      title: PhoneNumberResponse
  securitySchemes:
    APIKeyHeader:
      type: http
      scheme: bearer
      description: 'Your API key, sent as `Authorization: Bearer YOUR_API_KEY`'