Documents and Contracts Public APIs in Sparkforge

By Sparkforge Support Team ·Last reviewed May 3, 2026

Sparkforge exposes public APIs for listing documents, sending documents, listing templates, and generating-and-sending from a template in one call. Authenticate with a Private Integration token and integrate document workflows into your CRM or backend.

If you need document workflows in your own app, CRM, or backend automation, Sparkforge exposes a set of public APIs covering documents and contracts. Pull a list, send a document to a contact, fetch templates, or generate-and-send in a single call.

What the APIs cover

List Documents: retrieve every document tied to a Sparkforge location.
Send Document: dispatch an existing document to one or more contacts.
List Templates: fetch available templates dynamically.
Send Template: create a document from a template and send it in one API call.

Endpoints in detail

List Documents

Pull a full list of documents in a Sparkforge location. Useful for syncing records to dashboards or external CRMs and for integrations that depend on document metadata.

Send Document

Pick an existing document and send it to one or more contact IDs. Removes manual sending from the loop and keeps the process consistent.

List Templates

Fetch a central list of templates so automations can pick the right one for the right use case at runtime.

Send Template

Generates a new document from a template and sends it to designated contacts in a single call. Cuts the workflow to one action.

How to set up API access

Step 1: Get API credentials

In Agency Settings, open Private Integrations and create a Private Integration token. Tokens are preferred over API keys for tighter scope and revocation control. Grant only the scopes you need.

Step 2: Review the API docs

Visit the public API documentation portal and identify the endpoints your workflow needs (List Documents, Send Document, List Templates, Send Template).

Step 3: Test calls

Use Postman or any API client. Set the auth header:

Authorization: Bearer <your-token>

Pass the required parameters — document ID, template ID, or contact IDs.

Step 4: Validate responses

Inspect the JSON output and confirm documents or templates are returned and sent successfully.

Step 5: Integrate

Embed API calls into your CRM, automation script, or backend. Optionally chain them with Sparkforge workflows that fire on document events like Sent or Signed.

Step 6: Deploy securely

Store tokens in a secret manager, not source code.
Rotate tokens periodically.
Monitor usage to stay under rate limits.

Frequently Asked Questions

What endpoints does the Documents and Contracts API include?

Four core endpoints: List Documents, Send Document, List Templates, and Send Template (which generates and sends from a template in one call).

Where is the official API documentation?

The Sparkforge public API portal lists every endpoint with parameters, example payloads, and response schemas.

Do I need special permissions to call these APIs?

Yes. You need valid API credentials. Private Integration tokens are recommended over legacy API keys for scope and revocation control.

How do I test safely before going live?

Use Postman or a similar API client against test data. Confirm responses and side effects before pointing production workflows at the endpoints.

What's the difference between sending a document and sending a template?

A document is a specific file already in your account. A template is a reusable structure that generates a new document on demand. Send Template creates and sends in one call.