How to get there: Go to Settings in the sidebar → API & webhooks (opens a separate page) → API Tokens section.
Use the API to read portal data or create and update it from your own systems. The API reference lists endpoints and request fields.
If you are wiring ProductLift into an AI agent or LLM tool, point it at the machine-readable OpenAPI 3 specification instead of the human docs:
https://your-portal.example.com/llms.txtEach portal also serves its own copy of the spec at /docs/api.yaml, so you can target a specific customer portal directly.
To begin using the API, you'll need to generate an API token. Follow these steps:
30 days, 90 days, 1 year, or Never. Expired keys are automatically rejected by the API.The API keys list shows each key's name, scope badge, creation date, last-used time, and expiration. Use this to spot stale or unused keys and revoke them.
To revoke a key, click the trash icon next to it. Revoking a key takes effect immediately for the next API call made with it.
After creating a key, the success popup includes a curl command pointing at the GET /api/v1/portal endpoint. Paste it in a terminal, a 200 response with your portal details confirms the key is working. A 403 means the key is invalid, revoked, or expired.
API requests are rate limited per token. The default limit applied to most authenticated endpoints is 120 requests per minute. A handful of public endpoints (such as login helpers) carry stricter per-IP limits.
When you hit the limit the API returns HTTP 429 Too Many Requests. The response includes Retry-After, X-RateLimit-Limit, and X-RateLimit-Remaining headers, so clients can back off and retry automatically.
If you need a higher limit for a specific use case, contact support with details about the integration and expected request volume.
List endpoints return paginated results. Two pagination styles are in use depending on the endpoint.
GET /api/v1/posts) accept limit and skip (default 0). Posts, users, and companies allow up to 500 results per request. Other list endpoints have their own limits. Check the endpoint documentation for its default and maximum.page (default 1) and per_page (default 25, capped at 200), and return total, current_page, last_page, and per_page alongside the data.Refer to each endpoint in the API documentation for its exact pagination parameters and response shape.
Boards (called tabs in the API) and their sections are addressable and editable through the API. Use these when you script portal setup, migrate a portal, or rename structure from an external tool.
PATCH /api/v1/tabs/{slug} to change title, description, visibility, or sort order.PATCH /api/v1/sections/{id} to rename or reorder a section within its board.GET /api/v1/sections returns every section on the portal so you can look up IDs.GET /api/v1/statuses returns every status and the tab it belongs to. Useful when routing new posts to the correct changelog status (Added, Fixed, Improved).The full request and response schema for each of these endpoints lives at /docs/api.
ProductLift supports webhooks for real-time event notifications. To learn how to set up and use webhooks with ProductLift, visit our detailed guide:
Automate your workflows by integrating ProductLift with other applications using Pabbly Connect. For step-by-step instructions and use cases, refer to our integration guide:
Pabbly Connect Integration Guide
email_unsubscribed_at accepts a date and time such as 2026-10-23T08:50:00Z. API responses return this field in UTC using RFC 3339, for example 2026-10-23T08:50:00.000000Z. The Z means UTC. Input with a time-zone offset is converted to UTC, so 2026-10-23T10:50:00+02:00 represents the same time. A value of null means the user has not unsubscribed. Send null to clear the unsubscribe date.
This field previously returned the database format 2026-10-23 08:50:00. Integrations should now read the UTC timestamp, including its time zone.