> ## 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 Public API does and how it is organised.

The Scaleo Public API exposes the same data and operations available in the
web dashboard, organised by user role — **Advertiser**, **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                                                                        |
| --------------- | ----------------------------------------------------------------------------------- |
| **Advertisers** | Offers, profile, statistics.                                                        |
| **Affiliates**  | Offers, campaigns, payouts, click/conversion/referral stats.                        |
| **Managers**    | Full administration: advertisers, affiliates, offers, billing, tracking, reporting. |
| **All roles**   | Shared reference data — countries, categories, tags, tiers.                         |

## URL conventions

| URL prefix               | Role       |
| ------------------------ | ---------- |
| `/api/v2/network/...`    | Manager    |
| `/api/v2/advertiser/...` | Advertiser |
| `/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`.
</Note>

## Where to start

<Steps>
  <Step title="Get an API key">
    Read [Authentication](/network-api/authentication) and obtain an API key for your role.
  </Step>

  <Step title="Understand the response envelope">
    Read [Errors](/network-api/errors) so you can parse responses correctly.
  </Step>

  <Step title="Verify the key">
    Call `GET /api/v2/affiliate/profile` (or the equivalent for your role)
    to confirm the key works.
  </Step>

  <Step title="Build your integration">
    Browse the role-scoped sections in the sidebar for endpoints relevant to you.
  </Step>
</Steps>

## Support

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