Base URL
All API requests should be made to:Authentication
All requests require authentication via Bearer token:Response Format
All responses are returned in JSON format with this structure:Available Endpoints
Companies
List, search, and retrieve company data
Pricing
Access pricing intelligence data
Errors
Error codes and handling
Interactive API Reference
For a complete interactive API reference with all endpoints, parameters, and live testing:Full API Reference (Scalar)
View the complete OpenAPI specification with interactive examples
OpenAPI Specification
Access the raw OpenAPI spec:- Postman
- Insomnia
- Swagger UI
- Any OpenAPI-compatible tool
Common Request Patterns
List Resources
Search Resources
Filter Resources
Get Single Resource
Rate Limiting
All endpoints are subject to rate limits. See Rate Limits for details.
Quick Reference
Companies Endpoint
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/companies | List all companies |
| GET | /api/companies/{slug} | Get company by slug |
Common Query Parameters
| Parameter | Type | Description |
|---|---|---|
search | string | Search by name |
category | string | Filter by category |
employees | string | Filter by employee count |
limit | integer | Results per page (max 100) |
page | integer | Page number |
sort | string | Sort field and direction |