Skip to main content
The endpoint pages in this tab are generated from the OpenAPI document the API itself serves, built from the same schemas the server validates requests against. The document does not cover every partner surface yet: content reads, content interactions and the ad impression and click reports are documented by hand on guide pages instead. The Surfaces table below lists every partner surface and says where each one is documented.

​
Base URL

All examples and the interactive playground target the nonprod environment:
Production base URLs are provided during partner onboarding.

​
Conventions

  • Auth - Authorization: Bearer <org_... key> on the user, import, consent, XP and reward, recent events, module read and revenue endpoints. Key management (both org_ keys and ek_live_ tracking keys), module authoring, installation, credential and module webhook-endpoint operations take a partner admin session token as the bearer instead; the reference marks each operation with the scheme it accepts. Some member reads and writes, such as consents, redemption and the XP reads, also take the member’s own session token; the reference lists it on those operations. POST /v1/track and POST /v1/content-interactions take a publishable ek_live_... tracking key as ?key= or the body key field, and POST /v1/ingest takes an mk_live_... module credential. See Authentication.
  • Wire format - JSON with snake_case field names, except the tier, balance, XP earning and XP boost reads, which answer in camelCase. Timestamps are ISO 8601 with timezone; dates (like dob) are plain YYYY-MM-DD strings.
  • Errors - one envelope everywhere: { "error": { "code", "status", "message", "details"? } }. The code is stable; message wording is not a contract.
  • Idempotency - endpoints that declare it accept an Idempotency-Key header. Same key + same body → the original response is replayed. Same key + different body → 409 IDEMPOTENCY_CONFLICT.
  • Async jobs - bulk import validation and commit run asynchronously: the call returns 202 Accepted and you poll the job resource for state.

​
Surfaces

“Endpoints tab” means the surface is in the generated reference. Everything else is documented on the page named. The raw OpenAPI document is available at /openapi/partner.json.