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

# Get dashboard template

> One template with its spec. `scope=effective` (default): what this organization gets (its override merged over the shared template); `org`: its own row; `shared`: the platform's.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/dashboard-templates/{key}
openapi: 3.1.0
info:
  title: Sidenet API
  version: 1.0.0
  description: >-
    Sidenet HTTP endpoints exposed by the Sidenet Studio. All routes require an
    api key that can be generated through the studio in studio.sidenet.ai.
servers:
  - url: https://api.sidenet.ai
security:
  - bearerAuth: []
paths:
  /v1/dashboard-templates/{key}:
    get:
      tags:
        - Dashboard templates
      summary: Get dashboard template
      description: >-
        One template with its spec. `scope=effective` (default): what this
        organization gets (its override merged over the shared template); `org`:
        its own row; `shared`: the platform's.
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: string
            example: performance
        - name: scope
          in: query
          required: false
          schema:
            type: string
            enum:
              - effective
              - org
              - shared
            default: effective
          description: >-
            `effective` (default): what the organization gets — shared templates
            with its overrides applied, plus its own; `org`: its own rows only;
            `shared`: the platform's shared templates as published.
      responses:
        '200':
          description: The template
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    type: string
                    example: performance
                  collection:
                    type: string
                    description: >-
                      The publisher's set (`default` for a template written with
                      PUT).
                    example: pms
                  ord:
                    type: integer
                    description: Position in the picker (ascending, then key).
                  title:
                    type: string
                    example: Hotel performance
                  description:
                    type: string
                    nullable: true
                  icon:
                    type: string
                    nullable: true
                    example: chart
                  tags:
                    type: array
                    items:
                      type: string
                      example: general_manager
                    description: >-
                      Audience: offered on the networks whose `tags` share one
                      of these (`PATCH /v1/networks/{id}`). Empty = every
                      network.
                  when:
                    type: object
                    nullable: true
                    description: >-
                      Offered only when a read run **in the caller's session**
                      yields at least `min_options` distinct values: the spec's
                      own select filter `filter` (one with `options_from`: its
                      source and value path), or a source tool named outright
                      (`tool`, `args`, `value`: the field path of the value in a
                      row). E.g. `{ "tool": "pms_list_property_options",
                      "value": "id", "min_options": 2 }` offers a portfolio page
                      to a caller with several hotels only.
                    properties:
                      filter:
                        type: string
                        example: property
                      tool:
                        type: string
                        example: pms_list_property_options
                      args:
                        type: object
                      value:
                        type: string
                        example: id
                      min_options:
                        type: integer
                        minimum: 1
                        example: 2
                  spec:
                    type: object
                    description: >-
                      What `POST /v1/dashboards` takes as `spec`. Listed only
                      with `include_spec=true`.
                  enabled:
                    type: boolean
                  hash:
                    type: string
                  source:
                    type: string
                    enum:
                      - repo
                      - api
                    description: '`repo`: published by CI; `api`: written with PUT / PATCH.'
                  source_ref:
                    type: string
                    nullable: true
                    description: >-
                      The commit a `repo` template was published from, or who
                      wrote an `api` one.
                  origin:
                    type: string
                    enum:
                      - org
                      - shared
                      - override
                    description: >-
                      `org`: this organization's own; `shared`: the platform's,
                      shared with every organization; `override`: this
                      organization's row over a shared one (shown merged).
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
              example:
                key: performance
                collection: pms
                ord: 1
                title: Hotel performance
                description: >-
                  Occupancy, ADR, RevPAR and revenue with their trend for the
                  period.
                icon: chart
                tags:
                  - finance
                  - general_manager
                  - owner
                  - revenue_manager
                when: null
                enabled: true
                hash: 9f2c…
                source: repo
                source_ref: 1a2b3c4d5e6f
                origin: shared
                created_at: '2026-11-08T12:00:00Z'
                updated_at: '2026-11-08T12:00:00Z'
                spec:
                  name: Hotel performance
                  sources: []
                  panels: []
        '400':
          description: Invalid key or scope
        '404':
          description: No such template in that scope
      security:
        - bearerAuth: []
        - sessionToken: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Organization API key, generated in studio.sidenet.ai. Backend only —
        never in a browser.
    sessionToken:
      type: http
      scheme: bearer
      description: >-
        Session token (`snat_…`) minted by POST /v1/token. Carries the
        organization and the end user; safe in a browser.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.