Famulor Account API

Account-Informationen, Guthaben und einzelne Calls.

GitHub OpenAPI

Operations 2

GET /user/calls/{id} Get Call #
GET /user/me Get User Information #

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/famulor-io:famulor-io-account-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

famulor-io-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Famulor Account API
  summary: REST API für AI-Assistenten, Anrufe, Konversationen, Leads und omnichannel Kundenkommunikation.
  description: 'Die Famulor Produkt-API unter `https://app.famulor.de/api`. Damit steuerst du

    AI-Assistenten, startest und liest Anrufe, verwaltest Leads und Kampagnen,

    versendest SMS und WhatsApp-Nachrichten, pflegst Wissensdatenbanken und

    automatisierst Prozesse.


    ## Authentifizierung


    Alle Endpunkte erwarten einen API-Key als Bearer-Token:


    ```

    Authorization: Bearer YOUR_API_KEY

    ```


    Den Key erstellst du in deinem Account unter im

    Bereich API-Keys. Der Key wird nur einmal angezeigt.


    ## Webhooks


    Famulor sendet Ereignisse (Post-Call, Conversation Ended, Read Receipts) an

    deine URL. Die Payloads stehen im Abschnitt `webhooks` dieser Spec.


    Diese Datei wird aus der offiziellen Dokumentation generiert:'
  version: 1.0.0
  contact:
    name: Famulor Support
    email: sales@famulor.io
    url: https://www.famulor.io/support
  license:
    name: Proprietary
    url: https://www.famulor.io/terms
  termsOfService: https://www.famulor.io/terms
servers:
- url: https://app.famulor.de/api
  description: Production
security:
- BearerAuth: []
tags:
- name: Account
  description: Account-Informationen, Guthaben und einzelne Calls.
paths:
  /user/calls/{id}:
    get:
      tags:
      - Account
      summary: Get Call
      operationId: getCall
      description: 'Retrieve full details of a specific Famulor call by ID via API, including transcript, recording URL, duration, status and metadata from the AI voice assistant.


        Docs'
      externalDocs:
        description: Get Call
        url: https://docs.famulor.io/api-v1/user/calls/get
      parameters:
      - name: id
        in: path
        required: true
        description: The unique identifier of the call
        schema:
          type: integer
      responses:
        '200':
          description: Response
          content:
            application/json:
              example:
                id: 123
                assistant_name: Sales Assistant
                campaign_name: Q4 Outreach Campaign
                type: outbound
                duration: 245
                assistant_phone_number: '+1234567890'
                client_phone_number: '+1987654321'
                status: completed
                transcript:
                - text: Hello, this is Sarah from Famulor. How are you doing today?
                  type: transcript
                  sender: bot
                  timestamp: 1754055268.525861
                variables: []
                evaluation:
                - name: status
                  type: string
                  value: qualified_lead
                  description: Outcome of the call
                webhook_response:
                  status: success
                  data:
                    crm_contact_id: abc123
                carrier_cost: '0.02000000'
                total_cost: '0.02500000'
                answered_by: null
                recording_url: https://app.famulor.de/media/public/123/call_+491234567890_example.mp4
                created_at: '2025-08-04 14:30:00'
                updated_at: '2025-08-04 14:34:05'
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: The unique identifier of the call
                  assistant_name:
                    type: string
                    description: The name of the assistant that handled the call
                  campaign_name:
                    type: string
                    description: The name of the campaign this call belongs to (if applicable)
                  type:
                    type: string
                    description: The type of call (inbound, outbound or web)
                  duration:
                    type: integer
                    description: The duration of the call in seconds
                  assistant_phone_number:
                    type: string
                    description: The phone number used by the assistant
                  client_phone_number:
                    type: string
                    description: The customer's phone number
                  status:
                    type: string
                    description: The current status of the call
                  transcript:
                    type: array
                    description: The transcript of the call conversation as an array of entries
                    items: {}
                  variables:
                    type:
                    - object
                    - array
                    description: Variables collected during the call
                    additionalProperties: true
                  evaluation:
                    type: array
                    description: Evaluation data for call performance as an array of fields
                    items: {}
                  webhook_response:
                    type: object
                    description: Response from configured webhooks
                    additionalProperties: true
                  carrier_cost:
                    type: string
                    description: The carrier-calculated costs for this call
                  total_cost:
                    type: string
                    description: The total cost of the call including all fees
                  answered_by:
                    type:
                    - string
                    - 'null'
                    description: Who answered the call (human, machine or unknown), or `null`
                  recording_url:
                    type: string
                    description: URL to the call recording (if available and enabled)
                  created_at:
                    type: string
                    description: Date and time the call was created
                  updated_at:
                    type: string
                    description: Date and time the call was last updated
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Response
          content:
            application/json:
              example:
                message: Call not found
        '422':
          $ref: '#/components/responses/ValidationError'
  /user/me:
    get:
      tags:
      - Account
      summary: Get User Information
      operationId: getUserInformation
      description: 'Retrieve the profile, settings and account details of the currently authenticated Famulor user via API. Useful for verifying tokens and account state.


        Docs'
      externalDocs:
        description: Get User Information
        url: https://docs.famulor.io/api-v1/user/me
      responses:
        '200':
          description: Response
          content:
            application/json:
              example:
                name: Your Name
                email: example@example.com
                total_balance: 100.67447094
              schema:
                type: object
                properties:
                  name:
                    type: string
                    description: The full name of the user
                  email:
                    type: string
                    description: The email address of the user
                  total_balance:
                    type: number
                    description: The current total balance of the user account
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  responses:
    ValidationError:
      description: Die Anfrage ist inhaltlich ungültig.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
          example:
            message: The given data was invalid.
            errors:
              phone_number:
              - The phone number field is required.
    Unauthorized:
      description: Fehlender oder ungültiger API-Key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Unauthenticated.
  schemas:
    ValidationError:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          description: Feldname → Liste der Fehlermeldungen.
          additionalProperties:
            type: array
            items:
              type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Menschenlesbare Fehlermeldung.
        error:
          type: string
          description: Fehlerkennung, sofern gesetzt.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'API-Key als Bearer-Token: `Authorization: Bearer YOUR_API_KEY`. Key erstellen unter https://app.famulor.de.'
externalDocs:
  description: Famulor API-Dokumentation
  url: https://docs.famulor.io/api-v1/introduction