List Affiliates

tapfiliate.list_affiliates

ActionCRM & salesconnection required

Calls the Tapfiliate API with the connection's credentials.

List the account's affiliates, optionally narrowed to one program, referral code, parent affiliate or affiliate group.

Ask about Tapfiliate All Tapfiliate nodes Provider 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.

Field	Type	Required	Default	Constraints	Example
program_id Only list affiliates in this program; falls back to the connection's default program, and lists the whole account when neither is set.	string	No	—	—	johns-affiliate-program
referral_code Only list the affiliate holding this referral code.	string	No	—	—	mmu0zdy
parent_id Only list affiliates recruited by this parent affiliate.	string	No	—	—	janejameson
affiliate_group_id Only list affiliates in this affiliate group.	string	No	—	—	ag_77WCDy90IMs8m-sXpo

Example configuration

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

{
  "affiliate_group_id": "ag_77WCDy90IMs8m-sXpo",
  "parent_id": "janejameson",
  "program_id": "johns-affiliate-program",
  "referral_code": "mmu0zdy"
}

Output

One shape.

result

Field	Type	Example
count How many rows the response carried.	number	—
affiliates[].id The affiliate's slug, which every other node uses as its id.	string	—
affiliates[].firstname The affiliate's first name.	string	—
affiliates[].lastname The affiliate's last name.	string	—
affiliates[].email The email address the affiliate signs in with.	string	—
affiliates[].company The affiliate's company name, empty when none was given.	string	—
affiliates[].country Two-letter country code on the affiliate's profile.	string	—
affiliates[].status The affiliate's account status, such as active.	string	—
affiliates[].created_at ISO-8601 timestamp of when the affiliate was created.	string	—
affiliates[].meta_data The custom key/value metadata stored on the affiliate.	object	—

{
  "affiliates": [
    {
      "company": "",
      "country": "",
      "created_at": "",
      "email": "",
      "firstname": "",
      "id": "",
      "lastname": "",
      "meta_data": {},
      "status": ""
    }
  ],
  "count": 0
}

Related Tapfiliate nodes

See List Affiliates 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 demo Talk to sales