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

# List saved History views

> List the workspace's saved History views — named filter sets shared by everyone in the workspace and shown as tabs on the History page. To list a view's conversations, pass its `id` as `view_id` to `GET /history`. **Required scope:** `calls:read`.



## OpenAPI

````yaml /api-reference/openapi.json get /history/views
openapi: 3.1.0
info:
  title: Famulor API
  version: 1.0.0
  description: >-
    REST API for Famulor. Authenticate with an API key (`fam_...`, created under
    **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a
    Bearer token.


    Every response uses a consistent envelope: `{ "data": ... , "meta": { ... }
    }` on success and `{ "error": { "code", "message" } }` on failure. List
    endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`;
    `meta.pagination.total` carries the total match count.


    REST operations require API Access through the workspace plan or a recurring
    add-on. Without it, regular operations return `403 api_access_required`. The
    invoice-payment and billing-portal operations remain available with a valid
    `billing:write` credential after a failed plan payment so an authorized
    owner, admin, or billing member can recover billing.


    The same customer-facing capabilities are available as MCP tools at
    `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using
    the same credentials, scopes, and workspace access. MCP availability is
    controlled separately by Connect AI / MCP, not by API Access.
servers:
  - url: https://app.famulor.io/api/v1
    description: Hosted platform.
  - url: https://{domain}/api/v1
    description: White-label tenant domain — same paths, tenant branding.
    variables:
      domain:
        default: app.famulor.io
        description: Your white-label tenant domain.
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Self-inspection of the calling credential.
  - name: Migrations
    description: Preview and import data from supported legacy platforms.
  - name: Assistants
    description: Create and manage voice assistants.
  - name: Tools
    description: >-
      Reusable tools (HTTP APIs and external MCP servers) assistants can call
      mid-conversation.
  - name: Voices
    description: Browse the text-to-speech voice library.
  - name: Calls
    description: Start outbound calls and read call history, transcripts and recordings.
  - name: History
    description: Unified conversation history across calls, messaging and assistant emails.
  - name: Campaigns
    description: Outbound calling campaigns with a compliant power dialer.
  - name: Leads
    description: Manage Audience contacts across campaigns, channels and Call QA metrics.
  - name: Segments
    description: >-
      Saved, dynamic lead filters — reusable audience definitions used for
      Audience search and campaign lead assignment.
  - name: Suppression
    description: Cross-channel marketing opt-outs and active workspace suppression records.
  - name: Callbacks
    description: >-
      Scheduled callbacks booked by the Schedule callback tool across voice,
      chat, and email.
  - name: Phone Numbers
    description: Marketplace numbers and customer-provided numbers.
  - name: Famulor Loop
    description: >-
      Personal business-phone access, directory, presence, devices, and Loop
      call recents.
  - name: SIP Trunks
    description: Bring your own SIP provider and numbers.
  - name: Carrier Connections
    description: Connect a supported carrier account and import its existing phone numbers.
  - name: Knowledge Bases
    description: RAG knowledge bases and documents for assistants.
  - name: Settings
    description: Workspace-level settings such as caller-memory defaults.
  - name: Billing
    description: Balance and transaction ledger of the API key's workspace.
  - name: Automations
    description: >-
      Native workspace automations — list, create, update, trigger. Requires
      Automations in the workspace plan.
  - name: Milian Missions
    description: Recurring jobs that Milian runs unattended on schedule.
  - name: Integrations
    description: >-
      Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google
      Calendar, Outlook, native booking engine). Assign them to assistants to
      provide availability and booking tools, plus provider-supported
      appointment lookup, cancellation, and rescheduling.
  - name: Bookings
    description: >-
      Native booking engine — event types with weekly availability, public
      booking pages at /book/{workspace}/{slug}, and the bookings they produce.
  - name: Dashboards
    description: >-
      Custom analytics dashboards, reusable widgets, and tenant-scoped
      performance analytics. Requires Custom dashboards in the workspace plan.
  - name: Catalog
    description: >-
      Read-only platform catalogs — available models, supported assistant
      languages, and prompt templates.
  - name: Simulations
    description: Assistant simulation tests (plan-gated).
  - name: Versions
    description: Assistant configuration version history.
  - name: Caller IDs
    description: Outbound caller ID verification.
  - name: Widgets
    description: Web widget connectors.
  - name: Messaging
    description: >-
      Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK).
      Includes conversation delay, inactivity end, and conversation-ended
      webhooks.
  - name: QA
    description: Cohort AI Quality Assurance runs over call transcripts.
  - name: White Label
    description: >-
      Manage white-label customer accounts, defaults, credit transfers and
      customer plan offers. Each endpoint documents its required scope and
      workspace eligibility.
  - name: API Keys
    description: >-
      Self-service API keys for the calling workspace or a same-brand workspace
      where the credential's user is owner/admin. A key can only mint further
      keys with a scope subset of its own.
  - name: Workspaces
    description: >-
      List visible workspaces, create an additional workspace for the key owner,
      and mint a dedicated credential for a selected owner/admin workspace.
  - name: SMS
    description: Outbound SMS from workspace phone numbers.
  - name: Milian
    description: >-
      Ask Milian, the AI co-worker in your workspace, and start voice sessions
      with it.
  - name: Translation
    description: >-
      Live translation sessions that interpret a conversation between two
      languages.
paths:
  /history/views:
    get:
      tags:
        - History
      summary: List saved History views
      description: >-
        List the workspace's saved History views — named filter sets shared by
        everyone in the workspace and shown as tabs on the History page. To list
        a view's conversations, pass its `id` as `view_id` to `GET /history`.
        **Required scope:** `calls:read`.
      operationId: listHistoryViews
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: A page of the workspace's saved views, oldest first.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/HistoryView'
                  meta:
                    type: object
                    description: >-
                      Response metadata. `pagination.total` is the total number
                      of saved views.
                    properties:
                      pagination:
                        type: object
                        properties:
                          limit:
                            type: integer
                            example: 50
                          offset:
                            type: integer
                            example: 0
                          total:
                            type: integer
                            example: 1
              example:
                data:
                  - id: a7c1e2d3-0000-4000-8000-000000000644
                    name: Missed calls this week
                    filters:
                      type:
                        - call
                      status:
                        - no_answer
                        - busy
                        - failed
                      direction:
                        - outbound
                      date_range: last_7_days
                    created_by: u1b2c3d4-0000-4000-8000-000000000001
                    created_at: '2026-10-09T08:00:00Z'
                    updated_at: '2026-10-09T08:00:00Z'
                meta:
                  pagination:
                    limit: 50
                    offset: 0
                    total: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/RequestProtectionUnavailable'
components:
  parameters:
    limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
      description: Page size (1–200).
    offset:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
      description: Number of items to skip.
  schemas:
    HistoryView:
      type: object
      description: A saved History view, shared by everyone in the workspace.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        filters:
          $ref: '#/components/schemas/HistoryViewFilters'
        created_by:
          type:
            - string
            - 'null'
          format: uuid
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - filters
        - created_at
        - updated_at
    HistoryViewFilters:
      type: object
      description: >-
        Saved History filters: the same keys as the `GET /history` query
        parameters, lists as arrays. Lists match any of their values; different
        keys combine. Omitted keys do not filter; `{}` shows all conversations.
      additionalProperties: false
      properties:
        type:
          type: array
          items:
            type: string
            enum:
              - sms
              - call
              - avatar
              - email
              - live_chat
              - whatsapp_voice
              - whatsapp
              - telegram
              - slack
              - messenger
              - teams
              - discord
              - gchat
              - x
              - freshdesk
              - gmail
              - outlook
              - zendesk
              - servicenow
              - intercom
              - zoho_mail
              - agent_mail
              - instagram
              - zulip
          description: Conversation types (channels), any of.
        status:
          type: array
          items:
            type: string
            enum:
              - queued
              - ringing
              - in_progress
              - completed
              - failed
              - no_answer
              - busy
              - skipped
          description: Normalized statuses, any of.
        direction:
          type: array
          items:
            type: string
            enum:
              - inbound
              - outbound
              - web
          description: Directions, any of. `web` applies only to calls.
        assistant_id:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 50
          description: Assistant IDs, any of.
        campaign_id:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 50
          description: Campaign IDs, any of (calls only).
        tags:
          type: array
          items:
            type: string
            maxLength: 40
          maxItems: 32
          description: Audience contact tags, any of (case-insensitive).
        sentiment:
          type: array
          items:
            type: string
            enum:
              - positive
              - neutral
              - negative
          description: Analysis sentiments, any of.
        outcome:
          type: string
          enum:
            - successful
            - unsuccessful
          description: Analysis success verdict.
        qa:
          type: string
          enum:
            - passed
            - failed
          description: >-
            AI QA scorecard result (calls only; requires the AI QA Scorecards
            feature).
        min_duration:
          type: integer
          minimum: 0
          description: Minimum duration in seconds, inclusive (calls only).
        max_duration:
          type: integer
          minimum: 0
          description: Maximum duration in seconds, inclusive (calls only).
        date_range:
          type: string
          enum:
            - today
            - yesterday
            - last_7_days
            - last_30_days
            - last_90_days
            - this_month
            - last_month
          description: >-
            Relative period in the workspace timezone; stays relative. Not
            combinable with `from`/`to`.
        from:
          type: string
          description: >-
            `YYYY-MM-DD` (workspace calendar day) or an ISO 8601 date-time with
            timezone.
        to:
          type: string
          description: >-
            `YYYY-MM-DD` (whole workspace calendar day) or an ISO 8601 date-time
            with timezone.
        search:
          type: string
          maxLength: 200
          description: Free-text search, as in `GET /history`.
    ErrorEnvelope:
      type: object
      description: Error envelope returned by every /api/v1 endpoint on failure.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - api_access_required
                - not_found
                - invalid_request
                - rate_limited
                - conflict
                - telephony_configuration_error
                - telephony_unavailable
                - destination_forbidden
                - internal_error
                - service_unavailable
              description: >-
                Stable, machine-readable error code. `service_unavailable` is
                returned by POST /bookings and GET
                /booking-event-types/{id}/slots specifically when the
                availability engine could not be reached (see
                AvailabilityOrProtectionUnavailable).
            message:
              type: string
              description: Human-readable description of the error.
  responses:
    Unauthorized:
      description: Missing, invalid, expired or revoked API key / access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: unauthorized
              message: Invalid API key.
    Forbidden:
      description: >-
        The credential lacks the required scope or role, or the workspace does
        not have the required capability.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            scopeDenied:
              summary: Required scope is missing
              value:
                error:
                  code: forbidden
                  message: >-
                    This API key is missing the required scope
                    "assistants:write".
            apiAccessRequired:
              summary: API Access is not available
              value:
                error:
                  code: api_access_required
                  message: >-
                    API Access is not available for this workspace. Review
                    Settings → Plan.
    RateLimited:
      description: Too many requests. Retry after the indicated delay.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: rate_limited
              message: Too many requests. Retry after the indicated delay.
    RequestProtectionUnavailable:
      description: Request protection is temporarily unavailable.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: internal_error
              message: Request protection is temporarily unavailable.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        API key (`fam_...`, created under **Settings → API Keys**) or an OAuth
        2.0 access token (`fam_at_...`). REST operations also require API Access
        for the credential's workspace. Keys can be restricted to scopes such as
        `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`,
        `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`,
        `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`,
        `knowledge:write`, `voices:read`, `billing:read`, `billing:write`,
        `settings:write`, `platform:read`, `platform:write`; a `*:write` scope
        implies the matching `*:read`. Automation and dashboard endpoints also
        accept the legacy `calls:*` scope. Keys without scope restrictions have
        full access within the workspace's available capabilities.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.