# Formable API

- [Formable API](https://docs.formabledocs.com/index.md): Collect e-signatures with a REST API. Embed signing in your product, or send documents to be signed by email.
- [Set up a developer account](https://docs.formabledocs.com/developer-account.md): Create a Formable account, organization, API keys, and webhooks so you can call the API: all in less than 5 minutes.
- [Embedded Signing Quickstart](https://docs.formabledocs.com/quickstart.md): Create your first signature request and get an embeddable signing URL.
- [Authentication](https://docs.formabledocs.com/authentication.md): Authenticate API requests with an API key from Settings.
- [Core concepts](https://docs.formabledocs.com/concepts.md): The key objects and terms you'll work with when embedding e-signatures.
- [Embedded templates](https://docs.formabledocs.com/walkthroughs/embedded-templates.md): Create templates in your product for use with the signing API. Upload a file, embed the editor, then send with a signature request.
- [Embedded signing](https://docs.formabledocs.com/walkthroughs/embedded-signing.md): Let users sign documents inside your app with an embeddable signing URL.
- [Non-embedded signing](https://docs.formabledocs.com/walkthroughs/non-embedded-signing.md): Send a document for signature by email. Formable delivers the signing link.
- [Embedded redlining](https://docs.formabledocs.com/walkthroughs/redlining.md): Run a turn-based contract negotiation between two parties inside your product.
- [Overview](https://docs.formabledocs.com/sdks/overview.md): Official Formable SDKs for building with the Formable API in your preferred language.
- [Node](https://docs.formabledocs.com/sdks/node.md): Install and use formable-node, the official Node.js SDK for the Formable API.
- [Python](https://docs.formabledocs.com/sdks/python.md): Install and use formable-sdk, the official Python SDK for the Formable API.
- [PHP](https://docs.formabledocs.com/sdks/php.md): Install and use formable/formable-sdk, the official PHP SDK for the Formable API.
- [Java](https://docs.formabledocs.com/sdks/java.md): Install and use formable-sdk, the official Java SDK for the Formable API.
- [Go](https://docs.formabledocs.com/sdks/go.md): Install and use formable-go, the official Go SDK for the Formable API.
- [Ruby](https://docs.formabledocs.com/sdks/ruby.md): Install and use formable, the official Ruby SDK for the Formable API.
- [.NET](https://docs.formabledocs.com/sdks/dotnet.md): Install and use Formable, the official .NET SDK for the Formable API.
- [Dropbox Sign → Embedded templates](https://docs.formabledocs.com/migrations/dropbox-sign/embedded-templates.md): Migrate Dropbox Sign embedded templates (create_embedded_draft, edit_url) to the Formable API.
- [Dropbox Sign → Embedded signing](https://docs.formabledocs.com/migrations/dropbox-sign/embedded-signing.md): Migrate Dropbox Sign embedded signing (create_embedded, sign_url) to the Formable API.
- [Dropbox Sign → Non-embedded signing](https://docs.formabledocs.com/migrations/dropbox-sign/non-embedded-signing.md): Migrate Dropbox Sign non-embedded signing (signature_request/send, send_with_template) to the Formable API.
- [Docusign → Embedded templates](https://docs.formabledocs.com/migrations/docusign/embedded-templates.md): Migrate Docusign embedded template editing to Formable's upload and editUrl flow.
- [Docusign → Embedded signing](https://docs.formabledocs.com/migrations/docusign/embedded-signing.md): Migrate Docusign embedded signing (envelopes, recipient views) to the Formable API.
- [Adobe Acrobat Sign → Embedded templates](https://docs.formabledocs.com/migrations/adobe-acrobat-sign/embedded-templates.md): Migrate Adobe Acrobat Sign library documents and authoring views to Formable's upload and editUrl flow.
- [Adobe Acrobat Sign → Embedded signing](https://docs.formabledocs.com/migrations/adobe-acrobat-sign/embedded-signing.md): Migrate Adobe Acrobat Sign agreements and signing URLs to the Formable API.
- [Webhooks overview](https://docs.formabledocs.com/webhooks/overview.md): Receive real-time notifications when documents are viewed or signed.
- [Verifying webhooks](https://docs.formabledocs.com/webhooks/verifying-webhooks.md): Confirm that a webhook request genuinely came from Formable.
- [Event catalog](https://docs.formabledocs.com/webhooks/events.md): Every webhook event type and its payload schema.
- [API reference](https://docs.formabledocs.com/api-reference/introduction.md): REST endpoints for templates, signature requests, and related workflows.
- [Create a template](https://docs.formabledocs.com/api-reference/endpoint/create-template.md): Upload a PDF, DOC, or DOCX file to create a new template. The file must be under 40MB.
- [Create a template edit URL](https://docs.formabledocs.com/api-reference/endpoint/create-template-edit-url.md): Generates an edit URL for a template. The URL can be used to access the template editor interface. The client must be authorized to edit the template.
- [Create a regular signature request](https://docs.formabledocs.com/api-reference/endpoint/create-regular-signature-request.md): Creates a signature request for a template with one or more signers and emails each signer a signing link (same delivery path as sharing from the Formable platform). If template fields have assigned roles, `signers` must include a signer for each of those roles. Requires `signers` (array of email, n…
- [Create an embedded signature request](https://docs.formabledocs.com/api-reference/endpoint/create-signature-request.md): Creates an embedded signature request for a template with one or more signers. If template fields have assigned roles, `signers` must include a signer for each of those roles. Requires `signers` (array of email, name, and role, in signing order). Optional `sender` (email and name); when omitted, sen…
- [List signature requests](https://docs.formabledocs.com/api-reference/endpoint/list-signature-requests.md): Returns all signature requests for the authenticated client's organization, newest first. Optionally pass updatedSince to return only rows with updated_at after that instant (ISO-8601).
- [Get a signature request](https://docs.formabledocs.com/api-reference/endpoint/get-signature-request.md): Retrieves the signature request by ID. The response matches create: a `signers` array (each with `recipientSignatureId`) and envelope `fields` with current values. Signature image data is never returned; signature fields use `value: null` and include `signedAt` when signed. Use `status` to poll prog…
- [Create a signing URL](https://docs.formabledocs.com/api-reference/endpoint/create-signing-url.md): Generates a signing URL for a specific recipient on a signature request. Use the `recipientSignatureId` returned when creating the signature request. The URL can be used to access the signing interface for that recipient.
- [Get a signed envelope](https://docs.formabledocs.com/api-reference/endpoint/get-signed-envelope.md): Retrieves a presigned URL for the signed envelope associated with a signature request. The envelope must be in Completed status.
- [Get signature request events](https://docs.formabledocs.com/api-reference/endpoint/get-signature-request-events.md): Retrieves the list of events for a signature request. Requires JWT authentication.
- [Create a redline request](https://docs.formabledocs.com/api-reference/endpoint/create-redline-request.md): Creates a new redline request for a template with specified members. Each member must have an email, displayName, and role. The template must have a DOCX source file available for redlining.
- [List redline requests](https://docs.formabledocs.com/api-reference/endpoint/list-redline-requests.md): Returns all redline requests for the authenticated client's organization, newest updated first. Optionally pass updatedSince to return only rows with updated_at strictly after that instant (ISO-8601).
- [Get a redline request](https://docs.formabledocs.com/api-reference/endpoint/get-redline-request.md): Retrieves the redline request by ID
- [Update redline members](https://docs.formabledocs.com/api-reference/endpoint/put-redline-members.md): Replaces or upserts the members for an existing redline request. Each member must have an email, displayName, and role. Valid roles are DisclosingParty, ReceivingParty, DisclosingCounsel, ReceivingCounsel.
- [Create a redline URL](https://docs.formabledocs.com/api-reference/endpoint/create-redline-url.md): Generates a redline URL for a specific member email associated with a redline request. The member must already be part of the redline request. API-created URLs use the embedded path. If it is not that member's turn, an out-of-turn URL is returned instead.
- [Get redline request events](https://docs.formabledocs.com/api-reference/endpoint/get-redline-request-events.md): Retrieves the list of events for a redline request. Requires JWT authentication.
- [Get billing data](https://docs.formabledocs.com/api-reference/endpoint/get-billing.md): Returns the number of redlining sessions for client
- [Health check](https://docs.formabledocs.com/api-reference/endpoint/health-check.md): Returns the health status of the API server, including uptime and version information. This endpoint does not require authentication.
- [Create a template from a file upload](https://docs.formabledocs.com/api-reference/templates/create-a-template-from-a-file-upload.md): Upload a PDF, DOC, or DOCX file to create a new template. The file must be under 40MB.
- [Create a template edit URL](https://docs.formabledocs.com/api-reference/templates/create-a-template-edit-url.md): Generates an edit URL for a template. The URL can be used to access the template editor interface. The client must be authorized to edit the template.
- [List redline requests](https://docs.formabledocs.com/api-reference/redlining/list-redline-requests.md): Returns all redline requests for the authenticated client's organization, newest updated first. Optionally pass updatedSince to return only rows with updated_at strictly after that instant (ISO-8601).
- [Create a redline request](https://docs.formabledocs.com/api-reference/redlining/create-a-redline-request.md): Creates a new redline request for a template with specified members. Each member must have an email, displayName, and role. The template must have a DOCX source file available for redlining.
- [Update redline request members](https://docs.formabledocs.com/api-reference/redlining/update-redline-request-members.md): Replaces or upserts the members for an existing redline request. Each member must have an email, displayName, and role. Valid roles are DisclosingParty, ReceivingParty, DisclosingCounsel, ReceivingCounsel.
- [Create a redline URL for a member](https://docs.formabledocs.com/api-reference/redlining/create-a-redline-url-for-a-member.md): Generates a redline URL for a specific member email associated with a redline request. The member must already be part of the redline request. API-created URLs use the embedded path. If it is not that member's turn, an out-of-turn URL is returned instead.
- [Get a redline request](https://docs.formabledocs.com/api-reference/redlining/get-a-redline-request.md): Retrieves the redline request by ID
- [Get redline request events](https://docs.formabledocs.com/api-reference/redlining/get-redline-request-events.md): Retrieves the list of events for a redline request. Requires JWT authentication.
- [Create an embedded signature request](https://docs.formabledocs.com/api-reference/signature-requests/create-an-embedded-signature-request.md): Creates an embedded signature request for a template with one or more signers. If template fields have assigned roles, `signers` must include a signer for each of those roles. Requires `signers` (array of email, name, and role, in signing order). Optional `sender` (email and name); when omitted, sen…
- [List signature requests](https://docs.formabledocs.com/api-reference/signature-requests/list-signature-requests.md): Returns all signature requests for the authenticated client's organization, newest first. Optionally pass updatedSince to return only rows with updated_at after that instant (ISO-8601).
- [Create a regular signature request](https://docs.formabledocs.com/api-reference/signature-requests/create-a-regular-signature-request.md): Creates a signature request for a template with one or more signers and emails each signer a signing link (same delivery path as sharing from the Formable platform). If template fields have assigned roles, `signers` must include a signer for each of those roles. Requires `signers` (array of email, n…
- [Get a signature request](https://docs.formabledocs.com/api-reference/signature-requests/get-a-signature-request.md): Retrieves the signature request by ID. The response matches create: a `signers` array (each with `recipientSignatureId`) and envelope `fields` with current values. Signature image data is never returned; signature fields use `value: null` and include `signedAt` when signed. Use `status` to poll prog…
- [Create a signing URL for a recipient signature](https://docs.formabledocs.com/api-reference/signature-requests/create-a-signing-url-for-a-recipient-signature.md): Generates a signing URL for a specific recipient on a signature request. Use the `recipientSignatureId` returned when creating the signature request. The URL can be used to access the signing interface for that recipient.
- [Get a signed envelope for a signature request](https://docs.formabledocs.com/api-reference/signature-requests/get-a-signed-envelope-for-a-signature-request.md): Retrieves a presigned URL for the signed envelope associated with a signature request. The envelope must be in Completed status.
- [Get signature request events](https://docs.formabledocs.com/api-reference/signature-requests/get-signature-request-events.md): Retrieves the list of events for a signature request. Requires JWT authentication.
- [Get billing data](https://docs.formabledocs.com/api-reference/billing/get-billing-data.md): Returns the number of redlining sessions for client
- [Health check endpoint](https://docs.formabledocs.com/api-reference/health/health-check-endpoint.md): Returns the health status of the API server, including uptime and version information. This endpoint does not require authentication.

## OpenAPI Specs

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