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

# Get All Interactions

> A page of the ledger, labelled with the agent's title, the key's name and the files of the turn.

API key permission: Admin.



## OpenAPI

````yaml /api-reference/openapi.json get /interactions
openapi: 3.1.0
info:
  title: Neural Factory API
  version: 0.1.0
  description: >-
    The endpoints a program can call with an API key. Exchange the key's secret
    for a token at POST /apikeys/token and send it as a Bearer token.
servers:
  - url: https://api.neuralfactory.ai
    description: SaaS
  - url: https://{apiHost}
    description: 'Enterprise: the API address of your own deployment'
    variables:
      apiHost:
        default: api.example.com
        description: Your deployment's API host
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Chat
  - name: Runs
  - name: Agents
  - name: Workflows
  - name: Schedules
  - name: Knowledge bases
  - name: Documents
  - name: Search
  - name: Skills
  - name: Toolkits
  - name: Files
  - name: Interactions
  - name: Usage and billing
  - name: Catalogue
  - name: Browser
  - name: Users
  - name: Groups
  - name: Builds
paths:
  /interactions:
    get:
      tags:
        - Interactions
      summary: Get All Interactions
      description: >-
        A page of the ledger, labelled with the agent's title, the key's name
        and the files of the turn.


        API key permission: Admin.
      operationId: get_all_interactions_interactions_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number, starting from 1
            default: 1
            title: Page
          description: Page number, starting from 1
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Number of items per page
            default: 10
            title: Page Size
          description: Number of items per page
        - name: search
          in: query
          required: false
          schema:
            type: string
            description: Search query for filtering interactions
            default: ''
            title: Search
          description: Search query for filtering interactions
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Sort field: createdAt, name, email, message, response, agent,
              subagents, tools, client, feedback, cost, or apiKeyName
            title: Sort By
          description: >-
            Sort field: createdAt, name, email, message, response, agent,
            subagents, tools, client, feedback, cost, or apiKeyName
        - name: sort_order
          in: query
          required: false
          schema:
            type: string
            description: 'Sort order: asc or desc'
            default: desc
            title: Sort Order
          description: 'Sort order: asc or desc'
        - name: source
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/InteractionSource'
            description: 'Filter by row source: ''all'', ''agent_chat'' or ''workflow_run'''
            default: all
          description: 'Filter by row source: ''all'', ''agent_chat'' or ''workflow_run'''
        - name: from_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: From date in YYYY-MM-DD
            title: From Date
          description: From date in YYYY-MM-DD
        - name: to_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: To date in YYYY-MM-DD
            title: To Date
          description: To date in YYYY-MM-DD
        - name: tz
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              IANA time zone the dates are days of, e.g. Europe/Belgrade
              (default: UTC)
            title: Tz
          description: >-
            IANA time zone the dates are days of, e.g. Europe/Belgrade (default:
            UTC)
        - name: env
          in: query
          required: false
          schema:
            title: Env
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    InteractionSource:
      type: string
      enum:
        - all
        - agent_chat
        - workflow_run
      title: InteractionSource
      description: Discriminator filter for interaction rows (legacy docs have no source)
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The access_token returned by POST /apikeys/token for an API key's
        secret.

````

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