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

# Preview

> Requires the listed current workspace permission. Source policy, tenant lifecycle and provider prerequisites remain authoritative.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/builder/previews/{identifier}
openapi: 3.1.0
info:
  description: >-
    Selected current-source customer operations under preview. Access and
    integrations require workspace enablement; this is not a
    general-availability, onboarding or external-client registration promise.
    Request and query models come from code; many success responses have no
    response model and are intentionally untyped.
  title: Gather customer API — preview
  version: 0.1.0-preview
servers:
  - url: https://workspace.example.com
security: []
tags:
  - name: Governed data
  - name: HubSpot
  - name: Reviewed workflows
  - name: Rules and previews
  - name: Website preview
  - name: Workspace and observations
paths:
  /v1/builder/previews/{identifier}:
    get:
      tags:
        - Rules and previews
      summary: Preview
      description: >-
        Requires the listed current workspace permission. Source policy, tenant
        lifecycle and provider prerequisites remain authoritative.
      operationId: customer_get_v1_builder_previews_identifier
      parameters:
        - in: path
          name: identifier
          required: true
          schema:
            format: uuid
            title: Identifier
            type: string
        - in: query
          name: page
          required: false
          schema:
            default: 1
            maximum: 10000
            minimum: 1
            title: Page
            type: integer
        - in: query
          name: include_nonmatching
          required: false
          schema:
            default: false
            title: Include Nonmatching
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '401':
          description: Missing, expired or invalid workspace authentication.
        '403':
          description: >-
            Missing permission, browser-session requirement or CSRF validation
            failure.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '423':
          description: Workspace lifecycle currently denies activity.
        '503':
          description: Workspace control or required dependency unavailable.
      security:
        - TenantBearer: []
        - TenantSession: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    TenantBearer:
      bearerFormat: JWT
      description: >-
        Organization-bound Auth0 API access token. Required permissions are
        listed per operation; this does not offer API-key or client-registration
        issuance.
      scheme: bearer
      type: http
    TenantSession:
      description: >-
        Production host-only browser session. Read csrf_token from GET /v1/me
        using this session; bearer authentication returns a null CSRF token and
        takes precedence over cookies. Session mutations require exact Origin
        and X-CSRF-Token. Development uses signal_session.
      in: cookie
      name: __Host-signal_session
      type: apiKey

````

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