Skip to main content
Formalingo
API Reference

Documents

Upload and manage PDF/DOCX documents for digital signing.

Documents

Upload and manage PDF/DOCX documents for digital signing.

Endpoints

GET/api/v1/documents

List documents

Required permissions:documents:read
client.documents.get()
POST/api/v1/documents

Upload document — Upload a PDF or DOCX via multipart/form-data. Max 50 MB.

Required permissions:documents:write
client.documents.post(body)
GET/api/v1/documents/{id}

Get document

Required permissions:documents:read
client.documents.byId("ID").get()
PUT/api/v1/documents/{id}

Update document

Required permissions:documents:write
client.documents.byId("ID").put(body)
DELETE/api/v1/documents/{id}

Delete document

Required permissions:documents:delete
client.documents.byId("ID").delete()
POST/api/v1/documents/{id}/publish

Publish a document — Publishes the current draft as the next document revision. Requires user-backed auth context in addition to the documents:publish permission.

Required permissions:documents:writedocuments:publish
client.documents.byId("ID").publish.post(body)

This page is auto-generated from the OpenAPI spec. Run npm run docs:generate to update.

On this page

Copy this page as Markdown to use with AI tools.