Partner API Overview

The Partner API enables whitelabel partners to manage organizations, visitors, billing, and configuration programmatically. This documentation covers authentication, endpoints, and integration patterns.

Base URL

All Partner API requests use the following base URL:

https://api.app.bullseye.so/api/v1

Authentication

The Partner API uses API key authentication. Include your API key in the X-Partner-API-Key header with every request.

X-Partner-API-Key: your-api-key

See Authentication for details on obtaining keys and security best practices.

Rate Limiting

The Partner API enforces a rate limit of 1,000 requests per minute per partner account.

Rate limit information is returned in response headers:

If you exceed the limit, the API returns 429 Too Many Requests.

Error Format

Errors are returned as JSON with a consistent structure:

{
  "code": "error_code",
  "message": "Human-readable error message",
  "details": {}
}

Standard Error Codes

Response Conventions

• Successful responses use standard HTTP status codes (200, 201, 204).
• JSON responses use camelCase for property names.
• Paginated endpoints return page, pageSize, and total (or equivalent) for navigation.
• Timestamps are in ISO 8601 format (e.g., 2025-01-15T10:30:00Z).

Endpoint Groups