# FlowSign

> FlowSign documentation: product guides, REST API reference, webhooks and integrations.

- [FlowSign documentation](https://staging.docs.flowsign.app/index.md): Send documents for signature, build reusable templates, and drive FlowSign from your own systems with the REST API and webhooks.
- [Getting started](https://staging.docs.flowsign.app/getting-started.md): Create a FlowSign account and send your first document for signature.
- [Release labels](https://staging.docs.flowsign.app/release-labels.md): What Experimental and Coming soon mean when you see them in FlowSign.
- [Document types](https://staging.docs.flowsign.app/document-types.md): The difference between a Standard and a Dynamic document, and which one to choose when you add a file.
- [General](https://staging.docs.flowsign.app/guides/general/index.md): Guides for the pages every account starts from.
- [Home](https://staging.docs.flowsign.app/guides/general/home.md): Your account's landing page: activity stats, recent documents, document status, and an activity chart.
- [Notifications](https://staging.docs.flowsign.app/guides/general/notifications.md): A feed of updates about your documents and packages, grouped by date.
- [Packages](https://staging.docs.flowsign.app/guides/packages/index.md): Guides for sending, tracking and managing one-off document packages.
- [Packages](https://staging.docs.flowsign.app/guides/packages/all-packages.md): The full list of packages you can see, with search, filters, columns and bulk actions.
- [Packages (Board)](https://staging.docs.flowsign.app/guides/packages/kanban.md): Packages laid out as a board of status lanes, for dragging between stages.
- [Draft Packages](https://staging.docs.flowsign.app/guides/packages/drafts.md): Packages you have started but not yet sent.
- [Sent Packages](https://staging.docs.flowsign.app/guides/packages/sent.md): Packages that have been sent and are waiting on a recipient.
- [Action Required](https://staging.docs.flowsign.app/guides/packages/action-required.md): Packages waiting on something from you, with the action to take instead of a status column.
- [New Package](https://staging.docs.flowsign.app/guides/packages/create-package.md): Build a one-off package from documents, recipients, security and an email message, then send or schedule it.
- [Package](https://staging.docs.flowsign.app/guides/packages/package-detail.md): A sent or completed package's full detail page, tabs, and available actions.
- [Field editor](https://staging.docs.flowsign.app/guides/packages/fields-editor.md): Place signature, autofill and input fields on a package's documents and assign each to a signer.
- [Bulk send](https://staging.docs.flowsign.app/guides/bulk-send/index.md): Guides for sending one package per row of a list, all from the same template.
- [Bulk sends](https://staging.docs.flowsign.app/guides/bulk-send/bulk-sends.md): Every batch you've sent, one package per row, and how far each one has got.
- [New bulk send](https://staging.docs.flowsign.app/guides/bulk-send/create-bulk-send.md): Send one package per row of a list, all from the same template, in three steps.
- [Bulk send](https://staging.docs.flowsign.app/guides/bulk-send/bulk-send-detail.md): One batch's send progress and its per-recipient outcomes.
- [Templates](https://staging.docs.flowsign.app/guides/templates/index.md): Guides for building reusable templates, their fields, and public PowerForms.
- [Templates](https://staging.docs.flowsign.app/guides/templates/all-templates.md): Reusable workflows for sending documents to new recipients, with their statuses and a grid or list view.
- [Template Builder](https://staging.docs.flowsign.app/guides/templates/template-builder.md): Build or edit a reusable template, section by section, and place its fields.
- [Template Fields](https://staging.docs.flowsign.app/guides/templates/template-fields.md): Place and assign a template's signing fields per role, across its documents.
- [PowerForm](https://staging.docs.flowsign.app/guides/templates/powerforms.md): A public, unauthenticated link that lets anyone start and sign a package from a template.
- [Building a workflow](https://staging.docs.flowsign.app/guides/building-a-workflow.md): Turn a document you send often into a template with roles, fields, reminders and expiry.
- [Library](https://staging.docs.flowsign.app/guides/library/index.md): Guides for the shared document store: folders, recents, starred items and trash.
- [Library](https://staging.docs.flowsign.app/guides/library/all-files.md): Store folders and documents centrally, ready to attach to packages, templates and bulk sends.
- [Recents](https://staging.docs.flowsign.app/guides/library/recents.md): Documents recently added to the Library, across every folder.
- [Starred](https://staging.docs.flowsign.app/guides/library/starred.md): Folders and documents your team has starred, across the whole Library.
- [Trash](https://staging.docs.flowsign.app/guides/library/trash.md): Folders and documents deleted from the Library, kept until you restore or permanently delete them.
- [Prepare document fields](https://staging.docs.flowsign.app/guides/library/document-fields.md): Place fields on a Library document once, before it's attached to a package or template.
- [Contacts](https://staging.docs.flowsign.app/guides/contacts/index.md): Guides for managing the people and companies you send to.
- [Contacts](https://staging.docs.flowsign.app/guides/contacts/contacts.md): People and companies you send to, added automatically or by hand, organised into lists and labels.
- [Contact](https://staging.docs.flowsign.app/guides/contacts/contact-detail.md): One contact's details and the packages they've been part of.
- [Reports](https://staging.docs.flowsign.app/guides/reports/index.md): Guides for the audit trail, email history, document activity and team activity reports.
- [Reports](https://staging.docs.flowsign.app/guides/reports/all-reports.md): What FlowSign has recorded and sent, grouped into four reports.
- [Audit trail](https://staging.docs.flowsign.app/guides/reports/audit-trail.md): Every recorded event across member activity and signing, with the actor, IP address and origin behind each one.
- [Email history](https://staging.docs.flowsign.app/guides/reports/email-history.md): Every email FlowSign sent for your packages and team, with delivery status and bounce reasons.
- [Document activity](https://staging.docs.flowsign.app/guides/reports/document-activity.md): Throughput, completion and decline rates, time to sign, and the packages that have stalled.
- [Team activity](https://staging.docs.flowsign.app/guides/reports/team-activity.md): Per-member volume and outcomes, with a drill-in to any one person's activity.
- [Settings](https://staging.docs.flowsign.app/guides/settings/index.md): Guides for every organisation settings page.
- [Company](https://staging.docs.flowsign.app/guides/settings/company.md): Your organisation's name, plan, member count and company ID, plus closing the account.
- [Branding](https://staging.docs.flowsign.app/guides/settings/branding.md): Your logo and brand colour on the emails sent to signees.
- [Billing](https://staging.docs.flowsign.app/guides/settings/billing.md): Your active subscription, usage, billing email, payment method and invoices.
- [Members](https://staging.docs.flowsign.app/guides/settings/members.md): Invite and manage the people in your organisation, their roles and pending invitations.
- [Roles & Permissions](https://staging.docs.flowsign.app/guides/settings/roles-and-permissions.md): Manage what your team can access and do, and create custom permission profiles.
- [Groups](https://staging.docs.flowsign.app/guides/settings/groups.md): User groups for organising members, and signing groups for routing a signature to any one member of a group.
- [Organisation security](https://staging.docs.flowsign.app/guides/settings/security.md): Single sign-on, session limits, an IP allowlist and data retention for the whole organisation.
- [Workspaces](https://staging.docs.flowsign.app/guides/settings/workspaces.md): Separate offices or teams, each with its own packages, templates, contacts and members.
- [API keys](https://staging.docs.flowsign.app/guides/settings/api-keys.md): Access the FlowSign REST API from your own account.
- [Webhooks](https://staging.docs.flowsign.app/guides/settings/webhooks.md): Send real-time events to your systems, and monitor delivery health.
- [Custom fields](https://staging.docs.flowsign.app/guides/settings/custom-fields.md): Define the fields senders fill in on every package, and the key your integrations read them back by.
- [Integrations](https://staging.docs.flowsign.app/guides/settings/integrations.md): Storage connectors and third-party integrations, and how automations work.
- [Account](https://staging.docs.flowsign.app/guides/account/index.md): Guides for your personal profile, notification preferences, walkthroughs and support.
- [My Account](https://staging.docs.flowsign.app/guides/account/my-account.md): Your profile, signing identity and data, with Security & access, Preferences and My activity alongside.
- [Notifications (preferences)](https://staging.docs.flowsign.app/guides/account/notifications.md): Choose which events reach you, and where.
- [Walkthroughs](https://staging.docs.flowsign.app/guides/account/walkthroughs.md): An index of every guided product tour, and a link to the FAQ.
- [Support](https://staging.docs.flowsign.app/guides/account/support.md): Contact the FlowSign team, and find your organisation reference for support requests.
- [Signing](https://staging.docs.flowsign.app/guides/signing/index.md): Guides for the recipient-facing signing experience.
- [Signing a document](https://staging.docs.flowsign.app/guides/signing/signing-a-document.md): What a recipient sees when they open a signing link, and how they complete or decline it.
- [View links](https://staging.docs.flowsign.app/guides/signing/view-links.md): A read-only, shareable link to a package's documents, for someone who doesn't need to sign.
- [In-person signing](https://staging.docs.flowsign.app/guides/signing/in-person-signing.md): Hand your device to a recipient and let them sign on the spot, in a kiosk-style screen.
- [Changelog](https://staging.docs.flowsign.app/changelog.md): What has changed in FlowSign.
- [Developer quickstart](https://staging.docs.flowsign.app/developers.md): From no API key to a sent package in five requests.
- [Authentication](https://staging.docs.flowsign.app/api-reference/authentication.md): Bearer API keys, who can create them, and why a request is refused.
- [Workspaces](https://staging.docs.flowsign.app/api-reference/workspaces.md): Choosing which workspace an API call acts in.
- [Errors and rate limits](https://staging.docs.flowsign.app/api-reference/errors.md): Response envelopes, status codes, validation details and the request limit.
- [Pagination](https://staging.docs.flowsign.app/api-reference/pagination.md): Paging through packages and templates.
- [Use with AI](https://staging.docs.flowsign.app/api-reference/use-with-ai.md): Give a coding agent or assistant direct access to these docs.
- [List workspaces](https://staging.docs.flowsign.app/api-reference/endpoints/workspaces/list-workspaces.md): Returns the workspaces the API key's user can act in, and which one this call acted in. Pass a workspace id as `X-Workspace-Id` on any other call to act there; without the header, calls land in the organisation's default workspace.
- [List packages](https://staging.docs.flowsign.app/api-reference/endpoints/packages/list-packages.md): Returns a paginated list of packages visible to the caller. Honours the caller's package-visibility permissions.
- [Create a package](https://staging.docs.flowsign.app/api-reference/endpoints/packages/create-a-package.md): Creates a DRAFT package (or SCHEDULED when `scheduledAt` is set) with the given recipients and documents. `metadata` sets custom field values; unknown keys are rejected with 422, and so are missing required values when `scheduledAt` is set. Requires canSendPackages. Each document comes back with an…
- [Launch a package from a template](https://staging.docs.flowsign.app/api-reference/endpoints/packages/launch-a-package-from-a-template.md): Creates a package from the template, mapping each recipient onto the role of that name. Merge values go in `fields`; `workflowAnswers` and `documentAnswers` answer the questions the template's documents ask. `metadata` sets custom field values over the template's defaults; unknown keys are rejected…
- [Get package](https://staging.docs.flowsign.app/api-reference/endpoints/packages/get-package.md): Returns the package with recipients, documents, signing sessions, custom field values as `metadata`, and the last 100 audit events.
- [Delete a package](https://staging.docs.flowsign.app/api-reference/endpoints/packages/delete-a-package.md): Permanently deletes the package and its documents. Requires canDeletePackages.
- [Act on a package](https://staging.docs.flowsign.app/api-reference/endpoints/packages/act-on-a-package.md): Applies one of: send (DRAFT to IN_PROGRESS and starts signing; requires canSendPackages and every required custom field filled, else 422), void or on_hold (require canVoidPackages), or transfer ownership to `newOwnerId` (the current owner or canTransferPackages).
- [Download a package as one PDF](https://staging.docs.flowsign.app/api-reference/endpoints/packages/download-a-package-as-one-pdf.md): Returns the signed copies once the package has completed, and the originals before that. `documents` narrows the selection to a comma-separated list of document ids; omit it for all of them. `certificate=true` appends the certificate of completion, which is only available on a completed package.
- [Download a package as a zip](https://staging.docs.flowsign.app/api-reference/endpoints/packages/download-a-package-as-a-zip.md): Returns the signed copies once the package has completed, and the originals before that. `documents` narrows the selection to a comma-separated list of document ids; omit it for all of them. `certificate=true` appends the certificate of completion, which is only available on a completed package.
- [Download a package's certificate of completion](https://staging.docs.flowsign.app/api-reference/endpoints/packages/download-a-packages-certificate-of-completion.md): The signing record for a completed package: who signed, when, and from where. Returns 409 until the package completes.
- [List webhook endpoints](https://staging.docs.flowsign.app/api-reference/endpoints/webhooks/list-webhook-endpoints.md): Returns every webhook subscription for the caller's organisation. Requires canManageWebhooks.
- [Register a webhook endpoint](https://staging.docs.flowsign.app/api-reference/endpoints/webhooks/register-a-webhook-endpoint.md): Registers an HTTPS URL to receive the selected events. The `secret` in the response is returned exactly once: persist it to verify signatures. Requires canManageWebhooks.
- [Get webhook endpoint](https://staging.docs.flowsign.app/api-reference/endpoints/webhooks/get-webhook-endpoint.md): Returns the endpoint configuration plus its 25 most recent delivery attempts. Requires canManageWebhooks.
- [Delete a webhook endpoint](https://staging.docs.flowsign.app/api-reference/endpoints/webhooks/delete-a-webhook-endpoint.md): Permanently removes the subscription and its delivery history. Requires canManageWebhooks.
- [Update a webhook endpoint](https://staging.docs.flowsign.app/api-reference/endpoints/webhooks/update-a-webhook-endpoint.md): Updates any of url, description, events, or enabled. Re-enabling clears the failure counter so the endpoint is picked up again. Requires canManageWebhooks.
- [List templates](https://staging.docs.flowsign.app/api-reference/endpoints/templates/list-templates.md): Returns a paginated list of the workspace's templates. `status` filters by lifecycle state or 'all'.
- [Create a template](https://staging.docs.flowsign.app/api-reference/endpoints/templates/create-a-template.md): Creates a reusable template with roles, optional conditional questions, and merge fields. Documents and fields are added through the editor UI; the API doesn't upload PDFs.
- [Get a template](https://staging.docs.flowsign.app/api-reference/endpoints/templates/get-a-template.md): Returns the full template (roles, documents, fields, merge fields and the questions its documents ask) plus the current email, reminder and expiry config. Answer a document question by id in `documentAnswers` when creating a package from the template.
- [Delete a template](https://staging.docs.flowsign.app/api-reference/endpoints/templates/delete-a-template.md): Permanently removes the template. Packages instantiated from it are unaffected.
- [Update a template](https://staging.docs.flowsign.app/api-reference/endpoints/templates/update-a-template.md): Patches the template's core fields. Passing `roles`, `questions`, or `mergeFields` replaces those collections wholesale; omit them to leave the existing set alone.
- [Webhooks](https://staging.docs.flowsign.app/webhooks/overview.md): Receive signed HTTP notifications when packages and signing sessions change.
- [Events](https://staging.docs.flowsign.app/webhooks/events.md): Every webhook event and the fields in its payload.
- [Integrations](https://staging.docs.flowsign.app/integrations/index.md): Connect FlowSign to Zapier, n8n, Make and Power Automate.
- [Zapier](https://staging.docs.flowsign.app/integrations/zapier.md): Trigger Zaps from FlowSign events and create or send packages from a Zap.
- [n8n](https://staging.docs.flowsign.app/integrations/n8n.md): Trigger n8n workflows from FlowSign events and create or send packages from a workflow.
- [Make](https://staging.docs.flowsign.app/integrations/make.md): Trigger Make scenarios from FlowSign events and create or send packages from a scenario.
- [Power Automate](https://staging.docs.flowsign.app/integrations/power-automate.md): Trigger Power Automate flows from FlowSign events and create or send packages from a flow.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)