Get a campaign

Read the approved asset, issuance controls, and quantity accounts for a campaign.

Retrieve the configuration of one accessible campaign. Use this response to verify the intended reward asset and display authorized issuance capacity.

Endpoint#

GET /v1/campaigns/{campaignId}
Authorization: Bearer <your-server-api-key>

No request body or idempotency key is required.

TypeScript#

const campaign = await slices.campaigns.get("cmp_pilot001");
console.log(campaign.asset, campaign.budget.availableBaseUnits);

HTTP#

curl --silent --show-error \
  "$SLICES_BASE_URL/v1/campaigns/$SLICES_CAMPAIGN_ID" \
  --header "Authorization: Bearer $SLICES_API_KEY"

Response#

200 OK:

{
  "data": {
    "id": "cmp_pilot001",
    "name": "Local partner payout example",
    "asset": {
      "chainId": 31337,
      "tokenAddress": "0x0000000000000000000000000000000000002001",
      "symbol": "TST",
      "decimals": 6
    },
    "status": "active",
    "issuanceMode": "canary",
    "budget": {
      "authorizedBaseUnits": "100000000",
      "availableBaseUnits": "99000000",
      "queuedBaseUnits": "1000000",
      "approvedBaseUnits": "0",
      "deliveredBaseUnits": "0"
    },
    "maximumGrantBaseUnits": "10000000",
    "createdAt": "2026-09-11T11:00:00Z"
  }
}

All addresses, IDs, amounts, and timestamps in this example are synthetic. TST on chain 31337 is a local test profile, not an available production asset.

In this example, the campaign authorizes 100 TST, has 99 TST of unused capacity, and holds one accepted 1 TST reward that is waiting for the operator's approval. The example maximum per grant is 10 TST.

What a read does not reserve#

Reading available capacity does not reserve it for your next request. Concurrent callers may consume capacity before your issuance arrives. The issue operation enforces the cap atomically and may return BUDGET_EXCEEDED even after a recent campaign read showed enough capacity.

Likewise, status: active is not sufficient on its own: issuanceMode must permit the intended operation and recipient. The server enforces the current state when processing each write.

Capacity interpretation#

budget is a quantity-control view of authorizations and obligations. availableBaseUnits is not a token balance, and authorizedBaseUnits does not certify that the operator's wallet holds every possible future reward.

Use reward-level status to see where each allocation stands. The operator's wallet balance is checked by the dashboard's quote before each approval; this API does not report it.

Errors#

Unknown and out-of-project resources return 404 NOT_FOUND. Insufficient operation access returns 403 FORBIDDEN. An invalid or revoked key returns 401 UNAUTHENTICATED.

This read operation does not create, activate, pause, top up, or edit a campaign. Those operator/console workflows are separate from the public API.

Related: Campaign object, Campaigns, and Funding and budgets.