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/call2me-app:call2me-app-referrals-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.

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: Call2Me Referrals API
  description: '# Call2Me Voice AI Platform API


    Programmatic interface to build, deploy and operate voice AI agents that can place

    and receive phone calls in real time. Designed to be consumed by humans **and** by

    AI agent frameworks (function-calling LLMs, MCP servers, automation platforms like

    Composio, Pipedream, Zapier, n8n).


    ## What you can do


    - **Place outbound calls** — give an agent a phone number to dial; the AI handles

    the conversation end-to-end and returns a transcript + recording.

    - **Manage AI agents** — create personalities, attach voices, system prompts,

    knowledge bases and post-call actions.

    - **Schedule calls** — one-shot or recurring (cron-like) outbound calls.

    - **Knowledge base (RAG)** — upload documents/URLs so the agent answers from your

    data with reduced hallucination.

    - **Inbound** — provision phone numbers that route to your agents.


    ## Common LLM tool-calling use cases


    | Goal | Endpoint |

    |------|----------|

    | "Call this person and read them this script" | `POST /v1/calls` |

    | "Schedule a follow-up tomorrow at 14:00" | `POST /v1/schedules` |

    | "Get the transcript of last call" | `GET /v1/calls/{id}` |

    | "Add this PDF to the agent''s brain" | `POST /v1/knowledge-base/{id}/sources` |


    ## Authentication


    Every request requires a Bearer token issued from the dashboard:


    ```

    Authorization: Bearer c2m_sk_xxxxxxxxxxxxxxxx

    ```


    Get your API key from the API Keys page.

    Keys are scoped per-workspace and can be rotated/revoked any time.


    ## Rate Limits


    | Plan | Requests/min | Concurrent Calls |

    |------|-------------|------------------|

    | Free | 60 | 1 |

    | Pro | 600 | 10 |

    | Enterprise | Unlimited | Unlimited |


    ## SDKs & Integrations


    - Python SDK

    - Node.js SDK

    - OpenAPI 3.1 spec: `/openapi.json` (use it to generate clients or register the

    service with AI tool platforms)


    ## Support


    - Email: support@call2me.app

    - Docs: https://docs.call2me.app

    - Discord: https://discord.gg/call2me'
  version: 1.0.0
  x-logo:
    url: https://call2me.app/logo.png
    altText: Call2Me Logo
  contact:
    name: Call2Me Support
    url: https://call2me.app/support
    email: support@call2me.app
  license:
    name: Commercial — see Terms of Service
    url: https://call2me.app/terms
  termsOfService: https://call2me.app/terms
servers:
- url: https://api.call2me.app
  description: Production
- url: http://localhost:8000
  description: Local Development
security:
- BearerAuth: []
tags:
- name: Referrals
paths:
  /v1/referrals/apply:
    post:
      tags:
      - Referrals
      summary: Apply For Program
      description: Programa başvurur. Kod onayda üretilir — başvuran hemen link almaz.
      operationId: apply_for_program_v1_referrals_apply_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/src__routers__v1__referrals__ApplyRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Apply For Program V1 Referrals Apply Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/me:
    get:
      tags:
      - Referrals
      summary: My Partnership
      description: 'Kendi ortaklık durumu + kazanç özeti.


        Ortak değilse 404 — panel bunu "program sana kapalı" diye okur ve

        menüde bir şey göstermez.'
      operationId: my_partnership_v1_referrals_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response My Partnership V1 Referrals Me Get
  /v1/referrals/referred:
    get:
      tags:
      - Referrals
      summary: My Referred Customers
      description: 'Getirdiği müşteriler ve her birinden kazandığı toplam — sayfalı.


        E-posta maskelenir: ortak kimi getirdiğini bilmeli ama getirdiği

        müşterinin adresi onun verisi değil.


        Sayfalı çünkü başarılı bir ortak yüzlerce müşteri getirebilir; tek

        seferde hepsini çekmek hem sorguyu hem tabloyu boğardı.'
      operationId: my_referred_customers_v1_referrals_referred_get
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response My Referred Customers V1 Referrals Referred Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/track:
    post:
      tags:
      - Referrals
      summary: Track Referral
      description: 'Yeni kaydı bir davet koduna bağlar (kayıttan hemen sonra çağrılır).


        Geçersiz kod hata değil: `linked=false` döner. Kullanıcının kaydı

        bozuk bir referans linki yüzünden başarısız olmamalı.'
      operationId: track_referral_v1_referrals_track_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Track Referral V1 Referrals Track Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/admin/applications:
    get:
      tags:
      - Referrals
      summary: List Applications
      description: 'Başvuruları listeler (varsayılan: onay bekleyenler).'
      operationId: list_applications_v1_referrals_admin_applications_get
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
          default: pending
          title: Status
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response List Applications V1 Referrals Admin Applications Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/admin/{partner_id}/approve:
    post:
      tags:
      - Referrals
      summary: Approve
      description: Onaylar ve davet kodunu üretir.
      operationId: approve_v1_referrals_admin__partner_id__approve_post
      parameters:
      - name: partner_id
        in: path
        required: true
        schema:
          type: string
          title: Partner Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Approve V1 Referrals Admin  Partner Id  Approve Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/admin/{partner_id}/reject:
    post:
      tags:
      - Referrals
      summary: Reject
      description: Reddeder. Kod üretilmez, panelde program görünmez.
      operationId: reject_v1_referrals_admin__partner_id__reject_post
      parameters:
      - name: partner_id
        in: path
        required: true
        schema:
          type: string
          title: Partner Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Reject V1 Referrals Admin  Partner Id  Reject Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/admin/{partner_id}/suspend:
    post:
      tags:
      - Referrals
      summary: Suspend
      description: Askıya alır. Kod korunur — geçmiş atıflar ve komisyonlar bozulmasın.
      operationId: suspend_v1_referrals_admin__partner_id__suspend_post
      parameters:
      - name: partner_id
        in: path
        required: true
        schema:
          type: string
          title: Partner Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Suspend V1 Referrals Admin  Partner Id  Suspend Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/admin/commissions:
    get:
      tags:
      - Referrals
      summary: List Commissions
      description: Ödenecek komisyonları listeler — ödeme dışarıda, elle yapılır.
      operationId: list_commissions_v1_referrals_admin_commissions_get
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
          default: payable
          title: Status
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response List Commissions V1 Referrals Admin Commissions Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/referrals/admin/commissions/{commission_id}/mark-paid:
    post:
      tags:
      - Referrals
      summary: Mark Paid
      description: 'Ödendi olarak işaretler.


        Yalnız `payable` satır ödenebilir: bekleme süresi dolmamış (`pending`)

        bir komisyon iade riskindedir, iptal edilmiş (`void`) olan ise hiç

        doğmamıştır.'
      operationId: mark_paid_v1_referrals_admin_commissions__commission_id__mark_paid_post
      parameters:
      - name: commission_id
        in: path
        required: true
        schema:
          type: string
          title: Commission Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Mark Paid V1 Referrals Admin Commissions  Commission Id  Mark Paid Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ApproveRequest:
      properties:
        commission_pct:
          anyOf:
          - type: number
            maximum: 100.0
            minimum: 0.0
          - type: 'null'
          title: Commission Pct
      type: object
      title: ApproveRequest
    TrackRequest:
      properties:
        code:
          type: string
          maxLength: 32
          minLength: 4
          title: Code
      type: object
      required:
      - code
      title: TrackRequest
    src__routers__v1__referrals__ApplyRequest:
      properties:
        pitch:
          type: string
          maxLength: 2000
          minLength: 20
          title: Pitch
      type: object
      required:
      - pitch
      title: ApplyRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Enter your API key
externalDocs:
  description: Full developer documentation
  url: https://docs.call2me.app