> ## 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.

# Count packages by status

> Counts the packages `GET /api/v1/packages` lists, by status.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/packages/stats
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/stats:
    get:
      tags:
        - Packages
      summary: Count packages by status
      description: Counts the packages `GET /api/v1/packages` lists, by status.
      operationId: getPackagesStats
      parameters:
        - 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: object
                    properties:
                      total:
                        type: integer
                        minimum: 0
                        description: >-
                          Every package counted, whatever its status: those the
                          caller sent or was shared, or every package in the
                          organisation for a caller who can view all packages.
                        example: 42
                      byStatus:
                        type: object
                        properties:
                          DRAFT:
                            type: integer
                            minimum: 0
                            description: Packages not yet sent.
                            example: 5
                          SCHEDULED:
                            type: integer
                            minimum: 0
                            description: Packages queued to send at a scheduled time.
                            example: 2
                          IN_PROGRESS:
                            type: integer
                            minimum: 0
                            description: Packages out for signing.
                            example: 12
                          COMPLETED:
                            type: integer
                            minimum: 0
                            description: Packages signed by every signer.
                            example: 18
                          DECLINED:
                            type: integer
                            minimum: 0
                            description: Packages a recipient declined.
                            example: 1
                          ON_HOLD:
                            type: integer
                            minimum: 0
                            description: Packages paused by the sender.
                            example: 1
                          VOID:
                            type: integer
                            minimum: 0
                            description: >-
                              Packages ended early, including those that
                              expired.
                            example: 3
                        required:
                          - DRAFT
                          - SCHEDULED
                          - IN_PROGRESS
                          - COMPLETED
                          - DECLINED
                          - ON_HOLD
                          - VOID
                        description: >-
                          Packages counted by `PackageStatus`, one key per
                          status.
                      expired:
                        type: integer
                        minimum: 0
                        description: The part of `VOID` that ended at its expiry.
                        example: 1
                      partlySigned:
                        type: integer
                        minimum: 0
                        description: >-
                          The part of `IN_PROGRESS` that at least one recipient
                          has signed.
                        example: 4
                      viewed:
                        type: integer
                        minimum: 0
                        description: >-
                          Packages a recipient has opened, whatever their
                          status.
                        example: 20
                    required:
                      - total
                      - byStatus
                      - expired
                      - partlySigned
                      - viewed
                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
          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_*

````