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

# Scopes

> List all API key scopes

Returns the full list of scopes that can be assigned to API keys as a key-value map.

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "data": {
      "scopes": {
        "ideaclouds:read": "List and view IdeaClouds and questions",
        "ideaclouds:write": "Create IdeaClouds",
        "content:read": "List and view content, components, HTML",
        "content:write": "Create content, trigger generation",
        "compliance:write": "Trigger compliance checks",
        "content_tools:write": "Generate schemas, meta, social snippets",
        "inventory:read": "List and view inventory, descriptions, feeds",
        "inventory:write": "Trigger inventory description generation",
        "webhooks:read": "View webhook subscriptions and deliveries",
        "webhooks:write": "Create, update, delete webhook subscriptions",
        "site:read": "View site details, brand voices, elements, categories",
        "content_intelligence:read": "List and view content intelligence recommendations, dismiss recommendations",
        "content_intelligence:write": "Act on recommendations and bulk-dismiss"
      }
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /reference/scopes
openapi: 3.1.0
info:
  title: Hrizn Public API
  version: 1.2.0
  description: >
    The Hrizn Public API allows partners to programmatically create content,
    manage inventory descriptions, and integrate with the Hrizn platform.


    All endpoints are prefixed with `/public` and require an API key passed via
    the `X-API-Key` header (except the health check).
  contact:
    email: support@hrizn.io
servers:
  - url: https://api.app.hrizn.io/v1/public
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: IdeaClouds
    description: Create and manage AI-powered keyword research
  - name: Content Intelligence
    description: AI-powered content gap analysis and recommendations
  - name: Content
    description: Generate content from IdeaClouds
  - name: Compliance
    description: Run OEM compliance checks on content
  - name: Content Tools
    description: Generate SEO metadata, schemas, and social snippets
  - name: Inventory
    description: Access vehicle data and AI descriptions
  - name: Site
    description: View dealership details and configuration
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events
  - name: Reference
    description: Look up available types, scopes, and events
  - name: Social
    description: >-
      Zernio-backed social posting and reviews across all connected platforms
      (X, Facebook, Instagram, LinkedIn, Google Business Profile)
  - name: Health
    description: Health check (no authentication)
paths:
  /reference/scopes:
    get:
      tags:
        - Reference
      summary: List available scopes
      operationId: getReferenceScopes
      responses:
        '200':
          description: All API scopes
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      scopes:
                        type: object
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Hrizn API key (prefix hzk_)

````