This API is currently in beta phase, so there may be changes to endpoints and data structure. We appreciate your understanding and patience as we work to improve the API.
This feature is only available upon request. To request access, please contact support.If you already have access, view the documentation to learn how to manage your API keys.

​
Overview

Our API allows developers to interact with the data displayed on our platform programmatically. All API responses are returned in JSON format, making it easy to integrate with modern applications and tools.

​
Base URL

All API requests should be made to: 
https://api.tryprofound.com
Key capabilities:
  • Automate data retrieval and processing tasks
  • Create integrations with third-party applications
  • Generate custom reports and analytics
  • Access both processed and raw data from our prompt system

​
API Features

​
Report Generation

Create comprehensive reports with processed data from our prompt system. Compare performance metrics across different companies, time periods, or evaluation criteria to gain insights into your data.

​
Raw Data Access

Access unprocessed data within specific categories, giving you the flexibility to build custom reports and perform your own analysis using all available platform data.

​
Organization-Scoped Data

Each API key provides access to data belonging to its associated organization, ensuring proper data isolation and security.

​
Getting Started

To begin using the API, you’ll need an API key from your user profile on our platform. This key authenticates your requests and grants access to your organization’s data. For authentication details and request examples, see:

​
API Fundamentals

​
Data Organization

Each organization has access to specific categories and datasets. Use the /v1/org endpoints to:
  • Discover available data categories
  • Obtain identifiers for filtering
  • Understand your data scope and permissions

​
Required Parameters

All report endpoints require a category identifier, which you can retrieve from /v1/org/categories.

​
API Versioning

The current API version is v1. All endpoints are prefixed with /v1/ to ensure compatibility as the API evolves.

​
Rate Limits

Default limits: 600 requests per hour per API key.

​
Rate Limit Headers

Every API response includes these headers:
  • X-RateLimit-Limit: Your total request limit
  • X-RateLimit-Remaining: Remaining requests in current period
  • X-RateLimit-Reset: When the limit resets (Unix timestamp)

​
Handling Rate Limits

When you exceed the limit, you’ll receive a 429 Too Many Requests error. The response includes a Retry-After header indicating how long to wait before retrying. Need higher limits? Contact our support team to discuss your requirements.

​
Response Format

All API responses use JSON format with consistent structure for errors and successful responses.