The Portal API provides programmatic access to platform features through a RESTful interface. Your API key serves as authentication for all requests and should be stored securely. You can find your active API key in the Portal API Settings section, where you can copy it for use in your applications.

Understanding Credits and Usage

Your API plan operates on a credit-based system with a monthly allocation of credits, all portal subscriptions come with a small allotment of credits that reset each month, add-on API plans are available for increased usage. Each API call consumes credits based on the operation performed. You can monitor your current usage through the progress bar showing your consumption (e.g., 348/5,000 credits used this month).

Flexible Credit Usage

The platform offers Flexible Credit Usage to prevent service interruptions when you exceed your monthly limit. When enabled, you can continue using the API beyond your credit allocation, with additional usage billed at $0.005 per credit in increments of $25. This ensures your integrations continue running smoothly without unexpected downtime.

You can enable or disable this feature at any time through the settings panel, and you also have the option to set a usage limit to control your maximum monthly spending.

API Documentation and Support

For detailed endpoint information, request/response formats, and code examples, visit our comprehensive API documentation. The documentation includes:

• Complete endpoint reference
• Authentication methods
• Rate limiting information
• Code samples in multiple languages
• Response schemas and error codes

Managing Your API Plan

Need to make changes to your API plan? While we’re developing a self-service solution, you can currently request modifications by contacting us via Intercom. Our support team can help you adjust credit limits, review usage patterns, or upgrade your plan to meet your growing needs.

Use the “Update Settings” button to save any changes to your Flexible Credit Usage preferences. These changes take effect immediately and apply to your current billing cycle.