The Paperlink REST API gives you programmatic access to your team’s data so you can connect Paperlink with external systems, automate repetitive tasks, and build custom workflows. Common use cases include syncing your product catalog with a CRM, triggering document generation from a CI pipeline, and pulling data into custom reporting dashboards.Documentation Index
Fetch the complete documentation index at: https://developers.paperlink.online/llms.txt
Use this file to discover all available pages before exploring further.
Base URL
All API requests go to the following base URL:https://app.paperlink.online/api/v1/products.
Live and Test modes
Every API key is scoped to one of two modes. The mode is fixed at key creation and cannot be changed.| Mode | What it does |
|---|---|
| Live | Reads and writes your real production data. Use this for active integrations and production systems. |
| Test | Reads and writes an isolated sandbox that is completely separate from your live data. Use this during development and in CI/CD pipelines so you never risk touching real records. |
pk_live_ are Live keys and keys starting with pk_test_ are Test keys.
Test mode data is never visible in the Live environment and vice versa. You can create, update, and delete test records freely without affecting anything your users or clients will see.
API key scopes
When you create an API key you choose one of two permission scopes:| Scope | Permitted methods |
|---|---|
| Read & Write | GET, POST, PATCH, DELETE |
| Read-only | GET only |
403 error with the code scope_insufficient. Use Read-only keys for dashboards and reporting tools that should never be able to modify data.
Rate limits
The API enforces a sliding-window rate limit of 60 requests per minute per API key. Every response includes rate limit headers so you can track your usage:| Header | Value |
|---|---|
X-RateLimit-Limit | Maximum requests allowed per window (60) |
X-RateLimit-Remaining | Requests remaining in the current window |
X-RateLimit-Reset | Unix timestamp when the window resets |
429 Too Many Requests with a Retry-After header indicating how many seconds to wait before retrying.
Key limits
A team can have up to 10 active API keys at any time. If you reach the limit, revoke unused keys before creating new ones. Revoked keys remain visible in the list for 90 days for audit purposes, then disappear automatically.Only team members with the Owner or Admin role can create, rename, and revoke API keys. Manager and Member roles do not have access to the API Keys page.
Interactive API reference
The full interactive API reference is available at app.paperlink.online/api/docs. It lists every endpoint with request and response schemas, code samples in multiple languages, and a built-in Try it panel where you can make live API calls directly from the browser. If you are signed in as an Owner or Admin, the docs page offers a shortcut to inject your API key into the authorization field automatically.Where to go next
Authenticate with the API
Create an API key and learn how to pass it in your requests
API endpoints reference
Browse available endpoints with request and response examples
Integrations
Connect Paperlink with Slack, AI assistants, and more
Clients and products
Manage the product catalog you can read and write through the API