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

# Get package

> Returns the package with recipients, documents, signing sessions, custom field values as `metadata`, and the last 100 audit events.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/packages/{packageId}
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 belongs to the
    organisation and acts in one workspace per request: pass `X-Workspace-Id`
    (see `GET /api/v1/workspaces`) or omit it to act in the default workspace.
    Packages, templates, contacts and members are scoped to the workspace the
    call acts in.
servers:
  - url: https://my.flowsign.app
    description: Production
security:
  - ApiKey: []
paths:
  /api/v1/packages/{packageId}:
    get:
      tags:
        - Packages
      summary: Get package
      description: >-
        Returns the package with recipients, documents, signing sessions, custom
        field values as `metadata`, and the last 100 audit events.
      operationId: getPackagesByPackageId
      parameters:
        - schema:
            type: string
          required: true
          name: packageId
          in: path
        - schema:
            type: string
            description: >-
              The workspace to act in, from `GET /api/v1/workspaces`. Omit to
              act in the organisation's default workspace. A workspace the key's
              user cannot act in is treated as omitted.
          required: false
          name: x-workspace-id
          in: header
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      title:
                        type: string
                      status:
                        type: string
                        enum:
                          - DRAFT
                          - SCHEDULED
                          - IN_PROGRESS
                          - COMPLETED
                          - DECLINED
                          - ON_HOLD
                          - VOID
                      description:
                        type: string
                        nullable: true
                      recipients:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            email:
                              type: string
                            action:
                              type: string
                            actionType:
                              type: string
                              enum:
                                - SIGNER
                                - VIEWER
                                - CC
                            delay:
                              type: number
                          required:
                            - name
                            - email
                            - action
                            - actionType
                      emailSubject:
                        type: string
                        nullable: true
                      emailMessage:
                        type: string
                        nullable: true
                      signingOrder:
                        type: integer
                      documents:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            pageCount:
                              type: integer
                          required:
                            - id
                            - title
                            - pageCount
                      recipientSessions:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            recipientName:
                              type: string
                              nullable: true
                            recipientEmail:
                              type: string
                              nullable: true
                            status:
                              type: string
                              enum:
                                - WAITING
                                - ACTIVE
                                - COMPLETED
                                - DECLINED
                                - CANCELLED
                            order:
                              type: integer
                            sentAt:
                              type: string
                              nullable: true
                            openedAt:
                              type: string
                              nullable: true
                            completedAt:
                              type: string
                              nullable: true
                            declinedAt:
                              type: string
                              nullable: true
                            declineReason:
                              type: string
                              nullable: true
                          required:
                            - id
                            - recipientName
                            - recipientEmail
                            - status
                            - order
                            - sentAt
                            - openedAt
                            - completedAt
                            - declinedAt
                            - declineReason
                      auditEvents:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            eventType:
                              type: string
                            actorEmail:
                              type: string
                              nullable: true
                            metadata:
                              nullable: true
                            createdAt:
                              type: string
                          required:
                            - id
                            - eventType
                            - actorEmail
                            - createdAt
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      expiresAt:
                        type: string
                        nullable: true
                      completedAt:
                        type: string
                        nullable: true
                      metadata:
                        type: object
                        additionalProperties:
                          type: string
                        description: >-
                          Custom field values keyed by custom field `key`. `{}`
                          when none are set.
                    required:
                      - id
                      - title
                      - status
                      - description
                      - recipients
                      - emailSubject
                      - emailMessage
                      - signingOrder
                      - documents
                      - recipientSessions
                      - auditEvents
                      - createdAt
                      - updatedAt
                      - expiresAt
                      - completedAt
                      - metadata
                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'
        '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:
    Error:
      type: object
      properties:
        error:
          type: string
        details:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - error
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: fsk_*

````