> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scaleo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> What the Scaleo Broker API does and how it is organised.

The Scaleo Broker API exposes the same data and operations available in the
web dashboard, organised by user role — **Affiliate** and **Manager** —
plus a small set of shared resources.

All endpoints accept and return JSON, except binary download endpoints
(invoice PDFs, creative assets) which return raw file data.

## What you can do

| Role | Capabilities |
| - | - |
| **Affiliates** | Offers, campaigns, payouts, click/conversion stats, trader exports. |
| **Managers** | Full administration: affiliates, offers, billing, tracking, reporting, trader exports. |
| **All roles** | Shared reference data — countries, categories, tags, tiers. |

## URL conventions

| URL prefix | Role |
| - | - |
| `/api/v2/network/...` | Manager |
| `/api/v2/affiliate/...` | Affiliate |

> [!NOTE]
>
> `{id}` in paths is a numeric resource ID. All timestamps are ISO 8601 UTC,
> e.g. `2026-01-20T13:45:00Z`.

## Where to start

**1. Get an API key**

Read [Authentication](https://docs.scaleo.io/broker-api/authentication.md) and obtain an API key for your role.

**2. Understand the response envelope**

Read [Errors](https://docs.scaleo.io/broker-api/errors.md) so you can parse responses correctly.

**3. Verify the key**

Call `GET /api/v2/affiliate/profile` (or the equivalent for your role)
to confirm the key works.

**4. Build your integration**

Browse the role-scoped sections in the sidebar for endpoints relevant to you.

## Support

For integration support, contact your account manager or
[support@scaleo.io](mailto:support@scaleo.io).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.