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

# Get a Site

> Returns a Site's settings, live deployment, custom domains with their DNS records, and open previews.



## OpenAPI

````yaml https://api.usenotra.com/openapi.json get /v1/sites/{siteId}
openapi: 3.1.1
info:
  title: Notra API
  version: 1.0.0
  description: >-
    OpenAPI schema for Notra content endpoints. Use GET /v1/status for public
    reachability. Error responses include recovery guidance. Breaking changes
    ship under a new major path; deprecated operations send Deprecation and
    Sunset headers at least 90 days before removal.
servers:
  - url: https://api.usenotra.com
    description: Production
  - url: https://demo-api.usenotra.com
    description: >-
      Sandbox with sample data. Get a free sandbox key at demo.usenotra.com, no
      signup needed
security:
  - BearerAuth: []
tags:
  - name: Webhooks
    description: Manage outbound webhook subscriptions and delivery history.
  - name: Discovery
    description: Public API status and authenticated workspace discovery.
  - name: Content
    description: >-
      Manage posts, brand identities, and GitHub or Linear integrations, and
      queue content generation. Organization is inferred from the API key
      (identity.externalId).
  - name: Schedules
    description: >-
      Manage scheduled content generation. Organization is inferred from the API
      key (identity.externalId).
  - name: Event Triggers
    description: >-
      Manage event-based content generation triggered by GitHub webhooks.
      Organization is inferred from the API key (identity.externalId).
  - name: Chats
    description: >-
      Manage chat sessions. Organization is inferred from the API key
      (identity.externalId).
  - name: Skills
    description: >-
      Manage reusable writing skills. Organization is inferred from the API key
      (identity.externalId).
  - name: Feedback
    description: >-
      Collect and triage feedback submitted by AI agents. Agents post to the
      organization's feedback URL without credentials; reading and triage
      require an API key with feedback.read or feedback.write.
  - name: GEO
    description: >-
      Manage generative engine optimization: projects, tracking settings,
      prompts, prompt sequences, competitors, scans, visibility reads, content
      gaps and briefs, agent readiness and AI traffic. Project-scoped endpoints
      require the GEO plan entitlement in addition to their scope;
      organization-level ingest endpoints require only the traffic scope.
  - name: Sites
    description: >-
      Notra Sites are hosted blogs and changelogs built from a GitHub
      repository. Read Sites and their deployments, start builds, preview posts
      on a Site, open pull requests that publish posts to it, and manage
      blog.json authors and the author page through staged Design changes.
      Domains, settings, rollbacks and deletion stay in the dashboard.
externalDocs:
  description: Notra API versioning and deprecation policy
  url: https://www.usenotra.com/docs/api/versioning
paths:
  /v1/sites/{siteId}:
    get:
      tags:
        - Sites
      summary: Get a Site
      description: >-
        Returns a Site's settings, live deployment, custom domains with their
        DNS records, and open previews.
      operationId: getSite
      parameters:
        - schema:
            type: string
            minLength: 1
            pattern: ^[A-Za-z0-9_-]{1,100}$
            example: site_8f2kq1
          required: true
          in: path
          name: siteId
      responses:
        '200':
          description: Site fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSiteResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Plan limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden or missing the sites scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Organization, Site, deployment or post not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Sites request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Notra Sites is not available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Request timed out and may still complete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    GetSiteResponse:
      type: object
      properties:
        site:
          $ref: '#/components/schemas/SiteDetail'
        domains:
          type: array
          items:
            $ref: '#/components/schemas/SiteDomain'
        previews:
          type: array
          items:
            $ref: '#/components/schemas/SitePreview'
        organization:
          type: object
          properties:
            id:
              type: string
            slug:
              type: string
            name:
              type: string
            logo:
              type:
                - string
                - 'null'
          required:
            - id
            - slug
            - name
            - logo
      required:
        - site
        - domains
        - previews
        - organization
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        recovery:
          type: string
      required:
        - error
    SiteDetail:
      type: object
      properties:
        id:
          type: string
        projectId:
          type: string
        name:
          type: string
        slug:
          type: string
        status:
          type: string
          enum:
            - active
            - suspended
        suspendedReason:
          type:
            - string
            - 'null'
        repository:
          type:
            - object
            - 'null'
          properties:
            id:
              type:
                - string
                - 'null'
            owner:
              type: string
            name:
              type: string
          required:
            - id
            - owner
            - name
        productionBranch:
          type: string
        rootDirectory:
          type: string
          description: Directory in the repository that holds blog.json.
        liveUrl:
          type: string
          description: Public URL of the Site's first section.
          example: https://example.com/blog
        publicOrigin:
          type: string
        aliasOrigin:
          type: string
          description: Notra-hosted address that always serves the Site.
        mounts:
          type: object
          properties:
            blog:
              type: string
            changelog:
              type: string
        mountsFromConfig:
          type: boolean
          description: >-
            True when the live build's blog.json sets the sections, so the
            dashboard can't change them. Change them with PATCH
            /v1/sites/{siteId}/sections or in blog.json.
        previewsEnabled:
          type: boolean
        previewVisibility:
          type: string
          enum:
            - public
            - protected
        smartDeployments:
          type: boolean
        analyticsEnabled:
          type: boolean
        liveDeploymentId:
          type:
            - string
            - 'null'
        rollbackActive:
          type: boolean
          description: >-
            Production is pinned to an older build; new builds finish but don't
            go live until someone promotes one in the dashboard.
        liveSince:
          type:
            - string
            - 'null'
        createdAt:
          type: string
      required:
        - id
        - projectId
        - name
        - slug
        - status
        - suspendedReason
        - repository
        - productionBranch
        - rootDirectory
        - liveUrl
        - publicOrigin
        - aliasOrigin
        - mounts
        - mountsFromConfig
        - previewsEnabled
        - previewVisibility
        - smartDeployments
        - analyticsEnabled
        - liveDeploymentId
        - rollbackActive
        - liveSince
        - createdAt
    SiteDomain:
      type: object
      properties:
        id:
          type: string
        hostname:
          type: string
        kind:
          type: string
          enum:
            - subdomain
            - proxy
        status:
          type: string
          enum:
            - pending
            - verifying
            - active
            - failed
        isPrimary:
          type: boolean
        records:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - CNAME
                  - TXT
                  - A
              name:
                type: string
              value:
                type: string
              purpose:
                type: string
                enum:
                  - routing
                  - ownership
                  - certificate
            required:
              - type
              - name
              - value
              - purpose
        lastError:
          type:
            - string
            - 'null'
        verifiedAt:
          type:
            - string
            - 'null'
      required:
        - id
        - hostname
        - kind
        - status
        - isPrimary
        - records
        - lastError
        - verifiedAt
    SitePreview:
      type: object
      properties:
        previewKey:
          type: string
        deploymentId:
          type: string
        visibility:
          type: string
          enum:
            - public
            - protected
        url:
          type: string
        branch:
          type:
            - string
            - 'null'
        pullRequestNumber:
          type:
            - integer
            - 'null'
        commitSha:
          type:
            - string
            - 'null'
        activatedAt:
          type: string
      required:
        - previewKey
        - deploymentId
        - visibility
        - url
        - branch
        - pullRequestNumber
        - commitSha
        - activatedAt
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Send your API key in the Authorization header as Bearer API_KEY. Account
        API keys work in every workspace you belong to: send
        X-Notra-Organization-Id with the workspace id or slug to choose one.
        Workspace endpoints require it when you belong to more than one
        workspace; GET /v1/me/workspaces works without it. Organization keys
        only accept their own workspace there.

````

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