> ## 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.

# Get the skills catalog

> Returns the full catalog of available skills along with the calling workspace's
install state for each. For every active skill it reports metadata (display name,
description, category, publisher, runtime profile, version, trust tier, and any
featured ranking), whether it is system-locked (always on), its declared
prerequisites, and its required integrations each annotated with whether that
integration is currently met for this tenant. It also reports whether the tenant
explicitly enabled or disabled the skill, the effective enabled state (always true
when locked), the install status, and an icon URL when one exists. Requires agents
read access; scoped to the caller's own workspace.



## OpenAPI

````yaml GET /v1/skills/catalog
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/skills/catalog:
    get:
      tags:
        - integrations
      summary: Get the skills catalog
      description: >-
        Returns the full catalog of available skills along with the calling
        workspace's

        install state for each. For every active skill it reports metadata
        (display name,

        description, category, publisher, runtime profile, version, trust tier,
        and any

        featured ranking), whether it is system-locked (always on), its declared

        prerequisites, and its required integrations each annotated with whether
        that

        integration is currently met for this tenant. It also reports whether
        the tenant

        explicitly enabled or disabled the skill, the effective enabled state
        (always true

        when locked), the install status, and an icon URL when one exists.
        Requires agents

        read access; scoped to the caller's own workspace.
      operationId: skills_catalog
      responses:
        '200':
          description: Skills registry + this tenant's install state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillsCatalogResp'
      security:
        - bearer_pat:
            - agents:read
        - oauth2:
            - agents:read
components:
  schemas:
    SkillsCatalogResp:
      type: object
      required:
        - skills
      properties:
        skills:
          type: array
          items:
            $ref: '#/components/schemas/CatalogSkill'
    CatalogSkill:
      type: object
      required:
        - slug
        - display_name
        - publisher
        - profile
        - version
        - default_enabled
        - trust_tier
        - locked
        - requires
        - required_integrations
        - effective_enabled
        - featured
      properties:
        category:
          type:
            - string
            - 'null'
        default_enabled:
          type: boolean
        description:
          type:
            - string
            - 'null'
        display_name:
          type: string
        effective_enabled:
          type: boolean
        featured:
          type: boolean
          description: Promoted into the Featured strip; `featured_rank` orders it.
        featured_rank:
          type:
            - integer
            - 'null'
          format: int32
        icon_url:
          type:
            - string
            - 'null'
          description: |-
            Origin-served icon URL (`/v1/skills/catalog/{slug}/icon?v=<md5>`)
            when this skill has an `icon_svg`; `None` falls back to a
            lettermark tile in the UI.
        install_status:
          type:
            - string
            - 'null'
        locked:
          type: boolean
        profile:
          type: string
        publisher:
          type: string
        required_integrations:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationDep'
        requires:
          type: array
          items:
            type: string
        slug:
          type: string
        tenant_enabled:
          type:
            - boolean
            - 'null'
        trust_tier:
          type: string
        version:
          type: string
    IntegrationDep:
      type: object
      required:
        - slug
        - display_name
        - met
      properties:
        display_name:
          type: string
        met:
          type: boolean
        slug:
          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

````