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

# Find a package by external id

> Looks up a package by the `externalId` it was created with.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/packages/by-external-id/{externalId}
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/by-external-id/{externalId}:
    get:
      tags:
        - Packages
      summary: Find a package by external id
      description: Looks up a package by the `externalId` it was created with.
      operationId: getPackagesBy-external-idByExternalId
      parameters:
        - schema:
            type: string
          required: true
          name: externalId
          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: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The package's id. Pass it to `GET
                          /api/v1/packages/{packageId}` to fetch the full
                          package.
                        example: cmg4v8q2k0001s7xh3b9d2f6a
                      externalId:
                        type: string
                        nullable: true
                        description: The external id the package was created with.
                        example: crm-deal-48213
                      status:
                        $ref: '#/components/schemas/PackageStatus'
                      templateId:
                        type: string
                        nullable: true
                        description: >-
                          The id of the template the package was launched from,
                          or null when it was built from scratch.
                        example: K7dQm2xPz9Lw
                      createdAt:
                        type: string
                        description: >-
                          When the package was created, as an ISO 8601
                          timestamp.
                        example: '2026-09-21T02:14:07.000Z'
                    required:
                      - id
                      - externalId
                      - status
                      - templateId
                      - createdAt
                required:
                  - data
        '400':
          description: No externalId was given
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '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 in the organisation was created with that externalId, or
            the caller cannot see it
          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:
    PackageStatus:
      type: string
      enum:
        - DRAFT
        - SCHEDULED
        - IN_PROGRESS
        - COMPLETED
        - DECLINED
        - ON_HOLD
        - VOID
      description: >-
        The package's status. DRAFT is not yet sent; SCHEDULED is queued to send
        at its scheduled time; IN_PROGRESS is out for signing; COMPLETED is
        signed by every signer; DECLINED is refused by a recipient; ON_HOLD is
        paused by the sender; VOID is ended early by the sender or at its
        expiry.
      example: IN_PROGRESS
    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_*

````