Overview

The PromoteKit API enables you to programmatically manage your affiliate program, including affiliates, campaigns, referrals, commissions, and payouts. The API follows RESTful principles and uses standard HTTP methods. All requests and responses use JSON format.

Base URL

All API requests should be made to:

https://www.promotekit.com/api/v1

Authentication

All API endpoints require authentication using Bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer <API_KEY>

You can create API keys in Dashboard Settings → API Keys.

Response Format

All responses are returned in JSON format and include a success boolean indicating if the request was successful.

Success Response

{
  "success": true,
  "data": { ... }
}

Error Response

{
  "success": false,
  "error": {
    "message": "Error description",
    "type": "error_type"
  }
}

Rate Limiting

API requests are limited to 200 requests per minute per API key. If you exceed this limit, you'll receive a 429 Too Many Requests response.

Pagination

List endpoints support pagination using limit and page parameters:

limit - Number of records to return (default: 10, max: 100)
page - Page number, 1-indexed (default: 1)

Paginated responses include:

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total_count": 45,
    "total_pages": 5,
    "has_more": true
  }
}

Introduction