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

# Get the storefront settings

> How the Element appears on your product pages.



## OpenAPI

````yaml /openapi.json get /settings
openapi: 3.1.0
info:
  title: Filecheck API
  version: 1.1.0
  description: >-
    The Filecheck REST API. Submit files as jobs and fetch results, and set up
    your account: workflows, upload rules, preflight profiles, connectors,
    optimize presets, delivery destinations, product mappings, storefront
    settings and webhooks. All requests are authenticated server-side with your
    secret key (`sk_live_…`).
servers:
  - url: https://api.filecheck.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Jobs
    description: >-
      Submit files for preflight, fixing, optimization, validation and previews,
      and read the results.
  - name: Uploads
    description: Presigned credentials to upload large files directly.
  - name: Orders
    description: Attach jobs to commerce orders.
  - name: Workflows
    description: >-
      What happens to a customer's files for a product: the intake rule that
      checks them on upload, the processing streams, proofing, merging and
      delivery. Products in your store map to a workflow.
  - name: Rules
    description: >-
      Upload rules: which files a product accepts (kinds, MIME types, how many),
      which preflight profile checks each kind, and what happens when a file
      fails. A workflow's intake points at one rule.
  - name: Profiles
    description: >-
      Preflight profiles: the checks run on a file (size, bleed, resolution,
      colour, fonts…) with their thresholds, severities and automatic fixes. PDF
      profiles check PDFs (and vector and office files once converted); raster
      profiles check images.
  - name: Connectors
    description: >-
      Connectors wire a product page to the Element: what the shopper chose
      (size, page count, sides, finishing) adjusts the rule's size checks for
      that upload, and what FileCheck measured in the file (page count, size,
      area) can fill the page's own inputs so the store prices from the real
      file. The cart plugins store the chosen connector per product.
  - name: Optimize presets
    description: >-
      Saved optimize settings (compression, downsampling, colour conversion)
      that optimize steps can use.
  - name: Destinations
    description: >-
      Where finished files are delivered: SFTP and FTP hotfolders, S3 buckets,
      webhooks. Workflows list the destinations they deliver to. Secrets are
      write-only.
  - name: Products
    description: >-
      Which workflow each product in your store uses. The storefront Element
      opens the mapped workflow on the product page.
  - name: Settings
    description: >-
      How the storefront Element appears on your product pages: where it mounts,
      the add-to-cart button it guards, display mode and theme.
  - name: Webhooks
    description: >-
      HTTP callbacks for job, proof, account and billing events, signed with
      X-FileCheck-Signature.
paths:
  /settings:
    get:
      tags:
        - Settings
      summary: Get the storefront settings
      description: How the Element appears on your product pages.
      operationId: getSettings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    allOf:
                      - $ref: '#/components/schemas/Settings'
                      - $ref: '#/components/schemas/RecordFields'
        '401':
          description: Missing or invalid key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Settings:
      title: Storefront settings
      description: >-
        How the FileCheck Element (the upload form on your product pages)
        appears and behaves in your store. Every setting has a default; in a
        PATCH, null puts a setting back to it. Custom JS and CSS, which run code
        in your store, can only be changed in the dashboard.
      type: object
      additionalProperties: false
      properties:
        presentation:
          type:
            - string
            - 'null'
          enum:
            - inline
            - dialog
            - null
          default: inline
          description: >-
            inline: the upload form sits on the product page. dialog: an "Upload
            Files" button opens the form in a popup.
        mountSelector:
          type:
            - string
            - 'null'
          maxLength: 500
          default: ''
          description: >-
            CSS selector of the element the upload form (or, in dialog mode, its
            button) is placed into, used when the page has no element with id
            fc-inline. Empty: rely on #fc-inline (the Shopify app block and the
            cart plugins add it).
        moveMountBefore:
          type:
            - string
            - 'null'
          maxLength: 500
          default: ''
          description: >-
            Dialog mode only: CSS selector of an element the "Upload Files"
            button is inserted before (for example the quantity field). Empty:
            the button goes into #fc-inline, then mountSelector, then next to
            the add-to-cart button.
        cartButtonSelector:
          type:
            - string
            - 'null'
          maxLength: 500
          default: ''
          description: >-
            CSS selector(s) for the add-to-cart button, added to the built-in
            list. The Element keeps that button disabled until the customer's
            files are accepted, so set this when a theme's button isn't found.
        elementTheme:
          type:
            - string
            - 'null'
          enum:
            - light
            - dark
            - system
            - null
          default: light
          description: >-
            The upload form's colour theme. system follows the shopper's device
            setting.
        proofDetails:
          type:
            - string
            - 'null'
          enum:
            - collapsed
            - expanded
            - null
          default: collapsed
          description: >-
            How the proof opens for the customer. collapsed: the print first,
            with the issues behind a summary button. expanded: the list of
            issues open beside it.
        galleryProof:
          type:
            - boolean
            - 'null'
          default: false
          description: >-
            Show the product proof (3D model, folded leaflet, sheet, booklet) in
            place of the product page's own image gallery once every uploaded
            file has its proof. Off keeps the proof in the popup only.
        gallerySelector:
          type:
            - string
            - 'null'
          maxLength: 500
          default: ''
          description: >-
            CSS selector of the product gallery's container, for themes whose
            gallery the built-in selectors miss. Only used with galleryProof.
    RecordFields:
      type: object
      properties:
        id:
          type: string
          description: The record id.
        source:
          type: string
          enum:
            - domain
            - store
          description: '`domain`: yours. `store`: a built-in catalog record.'
        customized:
          type: boolean
          description: >-
            Your own copy of a built-in record, under the same id. Revert drops
            it.
        draft:
          type: boolean
          description: Present and true on an unpublished draft.
        draftExpiresAt:
          type: string
          format: date-time
          description: When an unpublished draft is deleted.
        created:
          type: integer
          description: Unix time (seconds).
        modified:
          type: integer
          description: Unix time (seconds).
    Error:
      type: object
      properties:
        error:
          type: boolean
          const: true
        code:
          type: string
          description: >-
            Machine-readable reason, such as validation_failed,
            invalid_reference, not_found, in_use, draft_reference.
        message:
          type: string
        param:
          type: string
          description: >-
            The field at fault, as a dotted path (intake.ruleId,
            accepts.0.preflight.profileId).
        details:
          type: array
          description: Every problem found, or the records that block a delete.
          items:
            type: object
            additionalProperties: true
        requestId:
          type: string
          description: Quote it to support.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret key as a bearer token, e.g. `Authorization: Bearer
        sk_live_…`. Secret keys are server-side only.

````

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