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

> ## Agent Instructions
> Flowsign is one word with a lowercase s.
> The REST API base URL is https://my.flowsign.app and every endpoint lives under /api/v1.
> When answering API questions, cite the HTTP method and endpoint path.
> API access needs the Enterprise plan and an API key with the API access permission.

# List a package's documents

> Returns the package's documents in order, each with a preview URL that expires after an hour.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/packages/{packageId}/documents
openapi: 3.0.3
info:
  title: Flowsign API
  version: 1.0.0
  description: >-
    Public v1 API for Flowsign. Every endpoint is authenticated with a Bearer
    API key (prefix `fsk_`). Errors use `{ error, details? }`; success responses
    wrap payload data as `{ data }`.


    An organisation is divided into workspaces. A key is issued for one
    workspace and acts there on every request (see `GET /api/v1/workspaces`);
    `X-Workspace-Id` is optional and may only name that workspace. Packages,
    templates, contacts and members are scoped to the key's workspace.
servers:
  - url: https://my.flowsign.app
    description: Production
security:
  - ApiKey: []
paths:
  /api/v1/packages/{packageId}/documents:
    get:
      tags:
        - Packages
      summary: List a package's documents
      description: >-
        Returns the package's documents in order, each with a preview URL that
        expires after an hour.
      operationId: getPackagesByPackageIdDocuments
      parameters:
        - schema:
            type: string
          required: true
          name: packageId
          in: path
        - schema:
            type: string
            description: >-
              The workspace the key was issued for, as returned by `GET
              /api/v1/workspaces`. Optional: omitting it acts in the key's
              workspace, and any other id is rejected with 401.
          required: false
          name: x-workspace-id
          in: header
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: '#/components/schemas/Document'
                        - type: object
                          properties:
                            previewUrl:
                              type: string
                              nullable: true
                              description: >-
                                A signed URL for the original file, valid for
                                one hour. Null when no file is stored for the
                                document, which includes every document of a
                                completed package 30 days after its signed
                                copies were sealed. For the signed copy, use
                                `GET
                                /api/v1/packages/:packageId/documents/:documentId`.
                              example: >-
                                https://xyzcompany.supabase.co/storage/v1/object/sign/pdf/cmg1org00001/cmg1ws000001/packages/cmg1p4k2a0003v9x0hq7d2e1s/cmg1p4k2a0007v9x0d8n3f5t2/Employment%20agreement.pdf?token=eyJhbGciOiJIUzI1NiJ9.eyJ1cmwiOiJwZGYvLi4uIn0.k3Yv8Qm2pL1nR7tW4xZc9aB5dE0fG6hJ
                          required:
                            - previewUrl
                      description: A document attached to a package or template.
                required:
                  - data
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Caller's plan does not include this feature (publicApi / webhooks)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key present but caller lacks the required permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No package with that id is visible to the caller
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Request failed schema validation; details keyed by field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded; see `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Document:
      type: object
      properties:
        id:
          type: string
          description: The document's id.
          example: cmg4v8q2k0003s7xhq1w8n5r7
        title:
          type: string
          description: 'The document''s title: its file name without the extension.'
          example: Employment agreement
        pageCount:
          type: integer
          description: How many pages the document has.
          example: 4
      required:
        - id
        - title
        - pageCount
      description: A document attached to a package or template.
    Error:
      type: object
      properties:
        error:
          type: string
          description: What went wrong, in plain words.
          example: 'Missing permission: canSendPackages'
        details:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Validation problems keyed by field path. Present only on 422
            responses.
          example:
            recipients.0.email:
              - Invalid email
      required:
        - error
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: fsk_*

````