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

# List email activity

> Returns a paginated feed of inbound and outbound email messages decorated with their
endpoint, plane and a deep-link to the conversation thread, along with the total
count for pagination. Admins see all workspace mail while a regular member sees only
mail bound to them. Supports optional filtering by handling state (handled,
awaiting_review, unrouted) and by endpoint, a limit (1-200, default 50), an offset,
and a sort of recent (default, newest first) or oldest.



## OpenAPI

````yaml GET /v1/api/email/activity
openapi: 3.1.0
info:
  title: HQ API
  description: >-
    Public HTTP API for HQ. Authenticate with a Personal Access Token
    (`Authorization: Bearer hq_pat_...`) for server-side integrations, or an
    OAuth 2.1 authorization-code + PKCE flow for browser apps acting on a user's
    behalf. Both grant from the same resource:action scope vocabulary; an
    endpoint's required scope is listed under its `security`.
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 1.0.0
servers:
  - url: https://api.hq.zone
    description: HQ API (production)
security: []
tags:
  - name: me
    description: The signed-in user's own account
  - name: conversations
    description: Conversations and their messages
  - name: documents
    description: The content-addressed documents library
  - name: schedules
    description: Scheduled prompts and recurring tasks
  - name: agents
    description: Agents, their skills and integrations
  - name: memory
    description: What the assistant remembers (L5 governance)
  - name: tokens
    description: Personal Access Token management
  - name: billing
    description: Usage and billing
  - name: notifications
    description: In-app notification center
  - name: admin
    description: Workspace administration
  - name: integrations
    description: Workspace integrations (Slack, MCP, skills)
  - name: onboarding
    description: New-workspace onboarding wizard
  - name: auth
    description: Sign-in, sessions, and OAuth
paths:
  /v1/api/email/activity:
    get:
      tags:
        - admin
      summary: List email activity
      description: >-
        Returns a paginated feed of inbound and outbound email messages
        decorated with their

        endpoint, plane and a deep-link to the conversation thread, along with
        the total

        count for pagination. Admins see all workspace mail while a regular
        member sees only

        mail bound to them. Supports optional filtering by handling state
        (handled,

        awaiting_review, unrouted) and by endpoint, a limit (1-200, default 50),
        an offset,

        and a sort of recent (default, newest first) or oldest.
      operationId: list_activity
      parameters:
        - name: state
          in: query
          description: |-
            Optional attention-state filter (`handled` / `awaiting_review` /
            `unrouted`).
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: endpoint_id
          in: query
          description: Optional endpoint filter.
          required: false
          schema:
            type:
              - string
              - 'null'
            format: uuid
        - name: limit
          in: query
          required: false
          schema:
            type:
              - integer
              - 'null'
            format: int64
        - name: offset
          in: query
          required: false
          schema:
            type:
              - integer
              - 'null'
            format: int64
        - name: sort
          in: query
          description: '`recent` (default, newest first) or `oldest`.'
          required: false
          schema:
            type:
              - string
              - 'null'
      responses:
        '200':
          description: Inbound + outbound email activity (scoped to the caller)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityListResp'
        '400':
          description: Unknown state filter
      security:
        - bearer_pat:
            - conversations:read
        - oauth2:
            - conversations:read
components:
  schemas:
    ActivityListResp:
      type: object
      description: >-
        Activity list response: one page of rows + the total count over the
        whole

        (scoped + filtered) set, so the UI can render "page X of Y".
      required:
        - rows
        - total
      properties:
        rows:
          type: array
          items:
            $ref: '#/components/schemas/ActivityRow'
        total:
          type: integer
          format: int64
    ActivityRow:
      type: object
      description: |-
        One row of the Activity feed: an inbound or outbound `email_message`,
        decorated with its endpoint + plane and a deep-link to the conversation
        thread (so opening it reuses the shared conversation renderer).
      required:
        - email_message_id
        - direction
        - handling_state
        - from_addr
        - to_addrs
        - occurred_at
      properties:
        agent_id:
          type:
            - string
            - 'null'
          format: uuid
        conversation_id:
          type:
            - string
            - 'null'
          format: uuid
          description: |-
            The conversation thread this mail belongs to (channel_kind='email',
            channel_thread=thread_key). `None` only for a parked item whose
            conversation was never materialised (unrouted / filed).
        direction:
          type: string
        email_message_id:
          type: string
          format: uuid
        endpoint_id:
          type:
            - string
            - 'null'
          format: uuid
        endpoint_localpart:
          type:
            - string
            - 'null'
        endpoint_plane:
          type:
            - string
            - 'null'
        from_addr:
          type: string
        handling_state:
          type: string
        llm_category:
          type:
            - string
            - 'null'
        llm_summary:
          type:
            - string
            - 'null'
        occurred_at:
          type: string
          format: date-time
        review_owner_id:
          type:
            - string
            - 'null'
          format: uuid
          description: |-
            The HQ user this `review_reply` item is attributed to; `null` = the
            admin Unassigned bucket. Only meaningful on the review_reply queue.
        subject:
          type:
            - string
            - 'null'
        to_addrs:
          type: array
          items:
            type: string
  securitySchemes:
    bearer_pat:
      type: http
      scheme: bearer
      bearerFormat: hq_pat
      description: 'Personal Access Token. Send as `Authorization: Bearer hq_pat_...`.'
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hq.zone/v1/oauth/authorize
          tokenUrl: https://api.hq.zone/v1/oauth/token
          refreshUrl: https://api.hq.zone/v1/oauth/token
          scopes:
            admin: Administer the workspace (users, settings, integrations)
            agents:read: View the agents in your workspace
            agents:write: Create and configure agents
            billing:read: View usage and billing information
            conversations:read: Read your conversations and their messages
            conversations:write: Start conversations and send messages on your behalf
            documents:read: Read your documents library
            documents:write: Upload and manage documents in your library
            memory:read: Read what the assistant remembers about you
            memory:write: Correct or delete what the assistant remembers
            schedules:read: View your scheduled tasks
            schedules:write: Create and manage scheduled tasks
            tables:read: Read your tables and their rows
            tables:write: Create tables and add, edit, or delete rows

````