Getting Started
Everything your IT team needs to integrate PaidLens with your organization.
Architecture Overview
PaidLens is a multi-tenant commission intelligence platform. Each organization gets an isolated environment with its own users, data stores, commission plans, and payout workflows.
Key Concepts
OrganizationYour company's PaidLens tenant. Identified by a unique org_id (e.g., org_abc123).
AdminFinance/RevOps users who manage commission plans, data stores, and payouts.
RepSales representatives who view their commission data and submit questions.
ManagerSales managers who see aggregated team views and approve payouts.
API KeyServer-to-server authentication token for programmatic access and integrations.
Quick Start
1
Get Your API Key
Your organization admin generates an API key from Admin → Integrations → API Keys.
2
Configure SSO (Optional)
Follow the guide to connect your identity provider (Okta, Azure AD, Google Workspace).
3
Set Up Webhooks (Optional)
Register endpoints to receive real-time notifications for payout approvals, disputes, and commission changes.
4
Authenticate API Requests
Include your API key in the Authorization header for all API calls.
Authentication
All API requests require an API key passed via the Authorization header:
curl -X GET https://app.paidlens.com/api/v1/users \ -H "Authorization: Bearer pl_live_abc123def456"
ℹ️
API keys are scoped to your organization. Keep them secure and never expose them in client-side code.
Rate Limits
| Tier | Limit | Window |
|---|---|---|
| Standard | 100 requests | per minute |
| Bulk operations | 20 requests | per minute |
| Webhook delivery | No limit | — |
SDKs & Libraries
Node.js / TypeScript
Coming SoonPython
Coming SoonREST / cURL
Available