Allocora
Docs / API Endpoint Reference

API Reference

Use Allocora API endpoints to automate payout data setup

Allocora exposes resource-oriented JSON endpoints for workspace automation. Use them to sync payees, products, revenue records, and payout rules from trusted server-side jobs.

Start Free Try Sample Data

Details

What to know

Base path and authentication

All public workflow endpoints live under /api/v1 and require a workspace API key sent as a bearer token.

  • Send Authorization: Bearer <ALLOCORA_API_KEY> from a server-side job only.
  • Use JSON request bodies and treat UUIDs from responses as stable resource identifiers.
  • Permissions are checked per action, such as read:payees, write:revenues, or write:rules.
  • Use /api/allocora/ping first when validating a new API key.

Use the entity pages

Each entity page lists the endpoints for that resource and includes request and response examples for every endpoint.

  • Payees: recipients, contact details, holds, thresholds, and fallback percentages.
  • Products: catalog identifiers, categories, tags, metadata, and archived status.
  • Revenues: sale, refund, and adjustment records with filters for reconciliation.
  • Rules: allocation configuration, activation status, upserts, and saved history.

Reference Tables

Fields and checks

Authentication and shared shapes

These conventions apply across payee, product, revenue, and rule endpoints.

Area Value Notes
Production base URL https://www.allocora.com/api/v1 Use the same path on your configured Allocora host.
Authentication header Authorization: Bearer <ALLOCORA_API_KEY> Create and rotate keys from the workspace integrations area.
Content type application/json Send JSON bodies for POST, PUT, and DELETE batch requests.
Batch body {"records": [...]} Maximum 100 records; responses include per-record status and meta counts.
Upsert key external_id plus operation operation is create_only, update_only, or create_or_update.

Entity reference pages

Open the entity page that matches the resource you want to automate.

Entity Docs page What it covers
Payees /docs/api-payees Recipients, contact details, holds, thresholds, batch updates, and upserts.
Products /docs/api-products Catalog records, categories, metadata, batch updates, upserts, and archive actions.
Revenues /docs/api-revenues Sales, refunds, adjustments, list filters, single creates, and batch creates.
Rules /docs/api-rules Allocation rules, activation status, upserts, batch updates, and saved history.

Troubleshooting

If this does not work

The request returns 401 Unauthorized.

Confirm the Authorization header includes Bearer followed by a current workspace API key and that the request is sent from a trusted server-side environment.

The request returns 403 Forbidden.

The key is valid but does not include the required permission. Create or rotate a key with the read or write permission named in the response.

A revenue create request returns outcome skipped_duplicate.

Allocora found the same external_id for the same revenue source and returned the existing record for idempotency. Use a new external_id only for a genuinely new transaction.

A rule update still shows earlier values in the versions list.

That is expected. The versions endpoint shows previous saved rule states for audit review.

Feedback

Was this page helpful?

Send a note if a step is unclear, missing, or out of date.

Email Support

Apply this in a workspace

Start free, use sample data, then replace examples with your own revenue rows when the workflow is clear.

Start Free Browse Docs