Connect to the PaperLink Public API

PaperLink's public REST API lets you integrate your team's data with external systems - CRMs, inventory tools, custom scripts, and automation pipelines. All access starts with an API key.

Open the Integrations Page

1. Go to Settings in the left sidebar.
2. Click Integrations.
3. Find the Public API card and click Connected (or open it directly from the card).

This takes you to the API Keys page where all keys for your team are listed.

Create an API Key

1. Click Create API Key in the top-right corner.
2. Enter a Key name - this is for your reference only and is not exposed to the API. Use something descriptive like Production Backend or CI Pipeline.
3. Choose a Mode:
   • Live - accesses your real production data. Use this for active integrations.
   • Test - accesses an isolated sandbox. Use this for development and CI/CD. Test keys cannot read or modify live data.
4. Choose a Scope:
   • Read & Write - can create, update, and delete data.
   • Read-only - can only retrieve data. Use this for reporting tools and dashboards.
5. Click Create key.

After creation, the confirmation screen shows:

• The full API token to copy
• A ready-to-use cURL example for your first request

Make Your First API Request

Use the token in the Authorization header as a Bearer token:

curl -H "Authorization: Bearer <your-token>" \
  https://app.paperlink.online/api/v1/products

Replace <your-token> with the key you just copied. The cURL example on the confirmation screen already has it filled in.

Manage Existing Keys

On the API Keys page, each key shows:

• Name and key prefix (e.g. pk_live_AbC...)
• Mode badge - Live (green) or Test (grey)
• Scope - Read & Write or Read-only
• Creator - the team member who created the key
• Last used - when the key was last used to make an API call

Use the ... menu on any key to Rename or Revoke it.

Revoke a Key

1. Find the key in the list and click ....
2. Select Revoke.
3. Confirm the action.

Revoked keys reject all API calls within seconds. The key remains visible in the list for 90 days so you can audit when it was revoked and by whom, then it disappears automatically.

Read the API Documentation

The interactive API reference is available at app.paperlink.online/api/docs. It shows all available endpoints with request and response schemas, code samples, and a built-in "Try it" panel where you can make live requests directly from the browser.

If you are logged in as OWNER or ADMIN, the docs page offers a shortcut to inject your API key into the auth field automatically.

Related

• PaperLink Now Has a Public REST API - what the API makes possible and how it is structured
• Connect Slack for Real-Time Notifications - get notified in Slack when someone engages with your documents
• Connect AI Assistant - link PaperLink with Claude, ChatGPT, and other AI tools via MCP
• Invite a Team Member - manage who has OWNER and ADMIN access on your team