Book a demo

List Commissions

tapfiliate.list_commissions
ActionCRM & salesconnection required

Calls the Tapfiliate API with the connection's credentials.

List commissions, optionally narrowed to one affiliate or a date range, for a payout run or an approval queue.

Ask about TapfiliateAll Tapfiliate nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Tapfiliate
Secret shape
the API key, or {"api_key": "…"}
Config it needs
program_id
Resolved by
config.connection_id, else node.connection_id

Configuration

4 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
affiliate_id
Only list commissions belonging to this affiliate.
stringNo——janejameson
pending
Set to true to include the commissions that are still awaiting a decision, or false to exclude them. Leave empty for the Tapfiliate default.
stringNo—one of "true", "false"—
date_from
Only list commissions created on or after this date, as YYYY-MM-DD.
stringNo—matches \d{4}-\d{2}-\d{2}2026-01-01
date_to
Only list commissions created on or before this date, as YYYY-MM-DD.
stringNo—matches \d{4}-\d{2}-\d{2}2026-12-31

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "affiliate_id": "janejameson",
  "date_from": "2026-01-01",
  "date_to": "2026-12-31"
}

Output

One shape.

result

FieldTypeExample
count
How many rows the response carried.
number—
commissions[].id
The commission's numeric id.
number—
commissions[].amount
The commission amount, in the commission's currency.
number—
commissions[].currency
Three-letter currency code the amount is in.
string—
commissions[].approved
True once the commission has been approved.
boolean—
commissions[].commission_type
The commission type that produced this amount.
string—
commissions[].commission_name
Display name of that commission type.
string—
commissions[].kind
Whether this is a regular commission or an override.
string—
commissions[].conversion_sub_amount
The conversion amount the commission came from.
number—
commissions[].affiliate
The affiliate the commission belongs to.
object—
commissions[].comment
Free-text comment stored on the commission.
string—
commissions[].payout
The payout the commission was paid in, when it has been.
object—
commissions[].created_at
ISO-8601 timestamp of when the commission was created.
string—
{
  "commissions": [
    {
      "affiliate": {},
      "amount": 0,
      "approved": false,
      "comment": "",
      "commission_name": "",
      "commission_type": "",
      "conversion_sub_amount": 0,
      "created_at": "",
      "currency": "",
      "id": 0,
      "kind": "",
      "payout": {}
    }
  ],
  "count": 0
}

Related Tapfiliate nodes

See List Commissions run in a workflow.

In a technical demo we add the Tapfiliate connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales