The Propal API is a RESTful API that lets you programmatically manage your proposals, contacts, products, templates, and more. Use it to integrate Propal with your CRM, build custom automations, or create dashboards with your proposal data.Documentation Index
Fetch the complete documentation index at: https://docs.propal.io/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
All API requests are made to:Resources
Proposals
Create, update, publish, and track proposals.
Leads
Manage contacts and sync them with your CRM.
Catalog
Manage your product catalog, items, bundles, and pricing.
Templates
List and use proposal templates.
Themes
Manage design themes: fonts, colors, and tokens.
Media
Upload and manage files and folders.
Metrics
Access pipeline, conversion, sales, and team analytics.
Organization
Read organization details and team members.
Key principles
| Principle | Description |
|---|---|
| REST + JSON | Standard HTTP methods, JSON request/response bodies, predictable URLs. |
| API key auth | Every request requires a Bearer token. Keys are scoped to an organization. |
| Cursor pagination | All list endpoints use limit and after parameters. |
| Consistent errors | Errors return structured JSON with a code and message. |
| Rate limited | Requests are throttled per organization. See rate limiting. |
| Signed uploads | File uploads use signed URLs — upload directly to storage, no size limit. See quickstart. |
Not in v1
The following are not available in the current API version:- Webhooks (planned)
- OAuth2 / delegated authorization
- Editing proposal rich text content (TipTap JSON)
- GraphQL / WebSockets
- Subscription and billing management
- PDF export