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

# Get site links

> Returns all configured dealership links

Returns all link elements configured for the site, such as SRP pages, service schedulers, credit applications, and custom links. These are used by the AI when generating content that references dealership pages.

**Scope required:** `site:read`

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "data": {
      "links": [
        {
          "id": "302f00df-1cbb-4cab-8014-141324596e92",
          "type": "new_vehicles_srp",
          "url": "https://www.shopempirechevrolet.com/VehicleSearchResults?search=new",
          "label": "New Vehicles",
          "created_at": "2025-01-27T20:32:43.639958+00:00",
          "updated_at": "2025-01-27T20:32:43.639958+00:00"
        },
        {
          "id": "642da1c4-7bb8-4524-b29b-04ecc164f3fd",
          "type": "used_vehicles_srp",
          "url": "https://www.shopempirechevrolet.com/VehicleSearchResults?search=preowned",
          "label": "Pre-Owned Vehicles",
          "created_at": "2025-01-27T20:32:43.639958+00:00",
          "updated_at": "2025-01-27T20:32:43.639958+00:00"
        },
        {
          "id": "fd8d75d6-7f99-48a5-9b2f-fc528ef7a0ce",
          "type": "service_scheduler",
          "url": "https://www.shopempirechevrolet.com/ServiceApptForm",
          "label": "Schedule Service",
          "created_at": "2025-01-27T20:32:43.639958+00:00",
          "updated_at": "2025-01-27T20:32:43.639958+00:00"
        }
      ]
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /site/links
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:
  /site/links:
    get:
      tags:
        - Site
      summary: List site links
      description: >-
        Returns all dealership links (SRP pages, service scheduler, credit
        application, etc.).
      operationId: getSiteLinks
      responses:
        '200':
          description: Site links
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteLinksResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    SiteLinksResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            links:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  type:
                    type: string
                    description: Link type (e.g. new_vehicles_srp, service_scheduler)
                  url:
                    type: string
                    nullable: true
                  label:
                    type: string
                    nullable: true
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: 'keyword: Required'
            details:
              type: object
            request_id:
              type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: API key lacks required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Hrizn API key (prefix hzk_)

````