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

# Get QWC file for a connection

> Returns a QWC file for the specified connection. The Web Connector lists it under the app's name followed by the connection's `name` in parentheses, and keeps it apart from other connections of the same app. Adding a newer file for the same connection replaces its entry.



## OpenAPI

````yaml /api-reference/v1/openapi.json get /connections/{connection_id}/qwc
openapi: 3.0.0
info:
  title: QuBe Sync API
  description: Integrate with QuickBooks Desktop or QuickBooks Enterprise in a few steps.
  version: 1.0.0
  contact:
    email: support@qubesync.com
servers:
  - url: https://qubesync.com/api/v1
    description: v1 API
  - url: https://dev.qubesync.com/api/v1
    description: Local development server
security: []
tags:
  - name: Connections
    description: Endpoints for managing QuickBooks connections
  - name: Queued Requests
    description: Endpoints for managing queued API requests
  - name: Pre-built Queries
    description: >-
      Endpoints for executing pre-built queries against QuickBooks data. These
      endpoints simplify common data retrieval operations by providing a
      higher-level interface than the raw queued requests API. Each query is
      executed asynchronously and returns a queued request ID that can be used
      to check the status and retrieve results.
paths:
  /connections/{connection_id}/qwc:
    get:
      tags:
        - Connections
      summary: Get QWC file for a connection
      description: >-
        Returns a QWC file for the specified connection. The Web Connector lists
        it under the app's name followed by the connection's `name` in
        parentheses, and keeps it apart from other connections of the same app.
        Adding a newer file for the same connection replaces its entry.
      parameters:
        - name: connection_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID of the connection
      responses:
        '200':
          description: QWC file generated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  qwc:
                    type: string
                    description: The contents of the QWC file
                    example: |-
                      <?xml version="1.0"?>
                      <QBWCXML>
                        <AppName>My App</AppName>
                        <AppID></AppID>
                        <AppURL>https://myapp.com/qbwc</AppURL>
                        <AppDescription>My App Description</AppDescription>
                        <AppSupport>https://myapp.com/support</AppSupport>
                        <UserName>550e8400-e29b-41d4-a716-446655440001</UserName>
                        <OwnerID>{550e8400-e29b-41d4-a716-446655440000}</OwnerID>
                        <FileID>{123e4567-e89b-12d3-a456-426614174000}</FileID>
                        <QBType>QBFS</QBType>
                        <Scheduler>
                          <RunEveryNMinutes>5</RunEveryNMinutes>
                        </Scheduler>
                      </QBWCXML>
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - apiKey: []
components:
  responses:
    Unauthorized:
      description: >-
        No usable API key. The key is Basic auth, so the answer is the
        challenge, with the plain-text body Unauthorized rather than JSON.
      headers:
        WWW-Authenticate:
          schema:
            type: string
            example: Basic realm="Application"
      content:
        text/plain:
          schema:
            type: string
          example: Unauthorized
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            errors:
              detail: Not Found
  schemas:
    Error:
      description: >-
        What a refused request answers with. The one key is errors, and its
        shape says what went wrong: a sentence when the endpoint explains the
        refusal in words (a parameter the operation does not take, a key already
        taken, a run that has already ended); an object with detail, and a code
        when there is one, when the request named nothing that exists or may not
        do what it asked (402, 403, 404, and a CLI session's 401), or an answer
        to a run's question was refused (the decisions endpoint's 400, 409 and
        422, which always carry a code to branch on); an object of fields, each
        a list of messages, when a record failed validation and nothing was
        saved; a list of {path, message} problems when a submitted document or
        input fails validation. A request without a usable API key gets a 401
        Basic challenge with the plain-text body Unauthorized, not JSON.
      properties:
        errors:
          oneOf:
            - example: 'unknown parameter: "emial"'
              title: A sentence
              type: string
            - properties:
                code:
                  example: read_only_session
                  type: string
                detail:
                  example: Not Found
                  type: string
              required:
                - detail
              title: Detail and code
              type: object
            - additionalProperties:
                items:
                  type: string
                type: array
              example:
                redirect_url:
                  - must be a valid URL
              title: Field by field
              type: object
            - items:
                properties:
                  message:
                    example: is required
                    type: string
                  path:
                    example: input.customer
                    type: string
                required:
                  - path
                  - message
                type: object
              title: Located problems
              type: array
      required:
        - errors
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: basic
      description: Use your app's API_KEY as the username, and leave the password blank

````

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