API keys

Creating a key

1. 1

   Settings → API Keys → create

   Name it after where it will be used, not after what it does. Future-you needs to know which key to revoke.

2. 2

   Copy it now

   The key is shown once. There is no way to retrieve it afterwards — only to replace it.

3. 3

   Send it as a header

   Every request authenticates with the key:

curl https://app.pipsync.io/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

Scope and limits

• A key is bound to one workspace and carries that workspace's permissions.
• Rate limits apply per key and per plan; exceeding them returns 429 with a retry hint.
• API access is a paid-plan feature — the endpoint list is on the API docs page.

• API documentation — endpoints, error codes and code samples.
• Authentication and rate limits by plan.
• Webhook events and signature verification.
• Interactive playground — try a call against your own workspace.

Key hygiene

• One key per integration. Shared keys cannot be revoked without breaking everything at once.
• Never commit a key, and never paste one into a support message or a screenshot.
• Rotate on a schedule and whenever someone with access leaves.
• Revoking is instant — requests with the old key fail immediately.