Getrewardful Rewardful API

Name: Rewardful API
Brand: Rewardful API
Availability: InStock

✓ Official Vendor SpecMarketingMarketing Automationbasic14 EndpointsREST

For Agents

Manage Rewardful affiliates, campaigns, referrals, and commissions, plus mint affiliate SSO links, through an HTTP basic-auth API key.

Install Jentic One Beta

Connect the Rewardful API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Rewardful API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Rewardful API.

Enrol an affiliate into a specific campaign with their email and payout details

List referrals attributed to a campaign or affiliate over a date window

Adjust a commission's amount or state after a refund, chargeback, or dispute

GET STARTED

Start building with Rewardful API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Rewardful API for, with concrete tasks.

★ Embed an affiliate dashboard in your product

SaaS companies surface affiliate stats inside the customer portal rather than sending users to Rewardful's hosted UI. The API returns affiliate, referral, and commission data, and the SSO magic-link endpoint lets users jump into the full Rewardful dashboard for actions such as updating payout details without re-authenticating.

Fetch referrals for affiliate aff_123 in the current month and render a summary, then mint an SSO link to the full dashboard

Refund-aware commission adjustment

When Stripe issues a refund, the commission for that referral often needs voiding. An automation pulls the related commission, calls PATCH /commissions/{commissionId} to change its state, and logs the adjustment. This keeps payouts accurate without manual reconciliation in the Rewardful UI.

When Stripe webhook charge.refunded fires, find the matching Rewardful commission and PATCH it to state 'void'

Bulk affiliate onboarding from a partner programme

A partnerships team imports a list of new affiliates from a CSV after an event or campaign launch. The API lets a script POST each affiliate with the right campaign id and email, returning the affiliate id used in subsequent referral tracking. This avoids the hosted sign-up flow when affiliates are pre-vetted.

For each row in partners.csv, POST /affiliates with the email and campaign id and write the returned affiliate id back to the row

AI agent for partner ops

An ops agent connected through Jentic answers questions like 'how much do we owe Acme this quarter?' by listing commissions filtered by affiliate and date range, summing eligible amounts, and surfacing pending versus due payouts. Jentic handles the basic-auth credential so the agent never sees the raw API secret.

List commissions for affiliate aff_acme over the last quarter and return total due and total paid

Key Endpoints

14 endpoints — rewardful is an affiliate, referral, and partner-marketing platform for saas companies that bills through stripe.

METHOD

PATH

DESCRIPTION

POST

/affiliates

Enrol a new affiliate

GET

/affiliates

List affiliates

POST

/affiliates/{affiliateId}/sso

Generate an affiliate SSO magic link

GET

/referrals

List referrals

GET

/commissions

List commissions

PATCH

/commissions/{commissionId}

Update a commission

POST

/campaigns

Create a campaign

POST

/affiliates

Enrol a new affiliate

GET

/affiliates

List affiliates

POST

/affiliates/{affiliateId}/sso

Generate an affiliate SSO magic link

GET

/referrals

List referrals

GET

/commissions

List commissions

PATCH

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Rewardful API secrets are stored encrypted in the Jentic vault. Agents receive a scoped reference and the basic-auth header is constructed per request, never exposing the raw key.

Intent-based discovery

Agents search by intent such as 'list rewardful commissions' and Jentic returns the matching operation along with its input schema.

Time to first call

Direct Rewardful integration: 1-2 days for auth and pagination across affiliates, referrals, and commissions. Through Jentic: under 30 minutes to search, load, and execute.

FAQs

Specific to using Rewardful API through Jentic.

What authentication does the Rewardful API use?

Rewardful uses HTTP basic authentication with your API secret as the username and a blank password. Through Jentic the secret is stored encrypted in the vault and the basic-auth header is built per request, so the raw key never enters agent context.

Can I update a commission after it has been issued?

Yes. PATCH /commissions/{commissionId} accepts updates to the commission state and amount, and DELETE on the same path removes it. This is the supported way to handle refund and chargeback adjustments without the Rewardful web UI.

What are the rate limits for the Rewardful API?

The OpenAPI spec does not declare hard rate limits. Treat the API as polite-use and paginate when listing affiliates, referrals, or commissions; for high-volume reconciliation jobs schedule them outside peak hours and back off on any 429 responses.

How do I enrol an affiliate into a campaign through Jentic?

Search Jentic for 'create rewardful affiliate', load the POST /affiliates schema, then execute with the email, first and last name, and campaign id. Jentic injects the basic-auth header automatically.

Can I generate a one-click sign-in link for an affiliate?

Yes. POST /affiliates/{affiliateId}/sso returns a single-use magic link that drops the affiliate directly into their Rewardful dashboard. This is the supported way to bridge from your product UI into Rewardful without asking the affiliate to log in again.

Is the Rewardful API free?

API access is bundled into all paid Rewardful plans and there is no separate API metering. Pricing scales with referral revenue rather than API call volume — check getrewardful.com/pricing for the current tiers.

Getrewardful Rewardful API

Connect the Rewardful API to your agent

Capabilities

Start building with Rewardful API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs