Profitroommod management API
Programmatic access to your Profitroommod account, module status and reporting data. Available for advanced integrations and automation workflows.
Base URL
https://api.profitroommod.org/v1
Authentication
Every request requires an Authorization: Bearer <api-key> header. API keys are generated per account and have the same access level as the account owner.
Available endpoints
| Endpoint | Method | Description |
|---|---|---|
/modules | GET | List every active module and its current status |
/modules/{id}/status | GET | Return the detailed status of a specific module |
/modules/{id}/logs | GET | Retrieve the last 500 API call logs for a module |
/credentials | GET | List the connected Profitroom API credential sets (masked) |
/credentials | POST | Add a new Profitroom API credential set |
/credentials/{id} | DELETE | Remove a Profitroom credential set |
/reports/{module} | GET | Retrieve a module usage report over a date range |
/billing/invoices | GET | List every invoice on the account |
/billing/invoices/{id} | GET | Download a specific invoice as PDF |
Rate limiting
The management API is limited to 120 requests per minute per API key. HTTP 429 is returned when the limit is exceeded. Use the Retry-After header value in your retry logic.
Outbound webhooks
Configure an outbound webhook URL in your Client Area dashboard to receive real-time notifications when: a module synchronisation fails, a billing event occurs, or a module is activated or cancelled. Events are delivered as JSON payloads over HTTP POST.
Questions
Questions about the API documentation: support@profitroommod.org.