> ## 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 freezable agents

> Returns every enabled agent in the caller's workspace alongside the calling user's
own freeze state for each: whether it is frozen, when it was frozen, and the reason.
Intended to drive a per-user "agents that can read your memory" toggle list. Scoped
to the caller's own account.



## OpenAPI

````yaml GET /v1/memory/agents
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/memory/agents:
    get:
      tags:
        - memory
      summary: List freezable agents
      description: >-
        Returns every enabled agent in the caller's workspace alongside the
        calling user's

        own freeze state for each: whether it is frozen, when it was frozen, and
        the reason.

        Intended to drive a per-user "agents that can read your memory" toggle
        list. Scoped

        to the caller's own account.
      operationId: list_freezable_agents
      responses:
        '200':
          description: Agents in the workspace + your freeze state for each
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreezableAgentsResp'
      security:
        - bearer_pat:
            - memory:read
        - oauth2:
            - memory:read
components:
  schemas:
    FreezableAgentsResp:
      type: object
      required:
        - agents
      properties:
        agents:
          type: array
          items:
            $ref: '#/components/schemas/FreezableAgent'
    FreezableAgent:
      type: object
      required:
        - agent_slug
        - display_name
        - frozen
      properties:
        agent_slug:
          type: string
        display_name:
          type: string
          description: >-
            User-facing agent name (tenant-renamable). The slug is an internal
            id;

            the UI must render this, not the lowercase slug.
        frozen:
          type: boolean
        frozen_at:
          type:
            - string
            - 'null'
          format: date-time
        reason:
          type:
            - string
            - 'null'
  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

````