Documents & Contracts: Public APIs
What are Documents & Contracts Public APIs?
The Documents & Contracts Public APIs provide a programmatic interface for developers to automate document-related tasks within your CRM. Instead of manually performing actions inside the application, you can use these APIs to integrate document workflows with external systems, custom applications, or automated processes. This feature is designed for developer-led automation and is scoped to work within a specific CRM location.
Key Benefits
Using these APIs offers several advantages for streamlining your business operations:
- Automate Document Delivery: Trigger the sending of documents directly from external tools or custom applications without requiring manual login to the CRM.
- Leverage Templates Efficiently: Generate new documents from pre-saved templates using a single API call, ideal for repetitive processes like proposals or contracts.
- Maintain Data Synchronization: Retrieve lists of documents and templates for reporting, system integration, or operational oversight.
- Scale Your Workflows: Connect API-driven document sends with other automation triggers for follow-ups, reminders, and status-based actions.
- Reduce Manual Errors: Standardize how templates are selected and documents are sent across different teams and systems.
Available API Actions
List Documents
This endpoint allows you to retrieve a list of all document records available within a specific CRM location. This is useful for integrations that need to sync document inventories, display available documents in another system, or check for existing assets before creating new ones.
Send Document
Use this endpoint to send an existing document that is already prepared and saved in your CRM to one or more contacts. This is helpful when document delivery needs to be triggered by an external application or custom business logic. Note that the document must already exist in the CRM before it can be sent via the API.
List Templates
This action retrieves a list of all reusable document templates available in your CRM location. It is particularly useful for populating a template selection interface in an external app or tool, ensuring users choose from approved, standardized templates.
Send Template
This endpoint combines two steps into one: it generates a new document from a saved template and sends it immediately. This is the most efficient option for automating the creation and delivery of repeatable documents like agreements or proposals, especially when the process originates from outside the CRM.
How to Set Up Documents & Contracts Public APIs
To begin using these APIs, you must ensure your integration is set up correctly. This involves secure authentication and using the correct endpoints for your specific CRM location. Before development, confirm that the Documents & Contracts feature is active and that the necessary documents or templates already exist in the correct location. You should also review whether your use case is best served by a private integration or a broader API implementation.