# Tapfiliate Tapfiliate is an affiliate and referral tracking platform that enables businesses to create, track, and scale their affiliate programs efficiently. - **Category:** marketing automation - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 40 - **Triggers:** 0 - **Slug:** `TAPFILIATE` - **Version:** 20260506_00 ## Tools ### Retrieve an Affiliate **Slug:** `TAPFILIATE_AFFILIATES_RETRIEVE_AN_AFFILIATE` Tool to retrieve details of a specific affiliate. Use when you have the affiliate_id and need full affiliate profile. ### Cancel a Payment **Slug:** `TAPFILIATE_CANCEL_PAYMENT` Tool to cancel a specific payment. Use when you need to cancel a payment by its payment_id. ### List all commissions **Slug:** `TAPFILIATE_COMMISSIONS_LIST_ALL_COMMISSIONS` Tool to retrieve all commissions. Use when you need to fetch commission records with optional filters and pagination after confirming valid API credentials. ### Create an Affiliate **Slug:** `TAPFILIATE_CREATE_AFFILIATE` Tool to create a new affiliate account. Use when you need to register a new affiliate with their contact details. ### Create Affiliate Group **Slug:** `TAPFILIATE_CREATE_AFFILIATE_GROUP` Tool to create a new affiliate group. Use when you need to organize affiliates into groups for management purposes. ### Create Affiliate Note **Slug:** `TAPFILIATE_CREATE_AFFILIATE_NOTE` Tool to create a note for an affiliate. Use when you need to add a note or comment to an affiliate's profile. ### Create Affiliate Prospect **Slug:** `TAPFILIATE_CREATE_AFFILIATE_PROSPECT` Tool to create an affiliate prospect. Use when you need to register a new potential affiliate before they become a full affiliate. ### Delete affiliate meta data **Slug:** `TAPFILIATE_DELETE_AFFILIATE_META_DATA` Tool to delete metadata by key for an affiliate. Use when you need to remove a specific metadata field from an affiliate's profile. ### Delete an affiliate prospect **Slug:** `TAPFILIATE_DELETE_AFFILIATE_PROSPECT` Tool to delete a specific affiliate prospect. Use when you need to remove an affiliate prospect by their affiliate_prospect_id. ### Delete an affiliate **Slug:** `TAPFILIATE_DELETE_AN_AFFILIATE` Tool to delete a specific affiliate. Use when you need to remove an affiliate by their affiliate_id after confirming it exists. ### Get Affiliate Balances **Slug:** `TAPFILIATE_GET_AFFILIATE_BALANCES` Tool to retrieve an affiliate's balances across multiple currencies. Use when you need to check an affiliate's current balance state. ### Get Affiliate Meta Data by Key **Slug:** `TAPFILIATE_GET_AFFILIATE_META_DATA_BY_KEY` Tool to retrieve specific metadata value by key for an affiliate. Use when you need to fetch a single custom metadata field. ### Get Affiliate Prospect **Slug:** `TAPFILIATE_GET_AFFILIATE_PROSPECT` Tool to retrieve details of a specific affiliate prospect. Use when you have the affiliate_prospect_id and need prospect information. ### Retrieve a Program **Slug:** `TAPFILIATE_GET_PROGRAM` Tool to retrieve details of a specific program. Use when you have the program_id and need full program information. ### List affiliate custom fields **Slug:** `TAPFILIATE_LIST_AFFILIATE_CUSTOM_FIELDS` Tool to get custom fields configured for affiliates. Use to retrieve the list of custom field definitions available for affiliate profiles. ### List all affiliate groups **Slug:** `TAPFILIATE_LIST_AFFILIATE_GROUPS` Tool to list all affiliate groups. Use to retrieve all affiliate groups in your Tapfiliate account. ### List Affiliate Meta Data **Slug:** `TAPFILIATE_LIST_AFFILIATE_META_DATA` Tool to retrieve metadata for a specific affiliate. Use when you need to fetch custom metadata key-value pairs associated with an affiliate. ### List affiliate notes **Slug:** `TAPFILIATE_LIST_AFFILIATE_NOTES` Tool to list notes for a specific affiliate. Use when you need to retrieve all notes associated with an affiliate by their ID. ### List affiliate's payments **Slug:** `TAPFILIATE_LIST_AFFILIATE_PAYMENTS` Tool to list all payments for a specific affiliate. Use when you need to retrieve payment records for a particular affiliate by their affiliate_id. ### List Affiliate Programs **Slug:** `TAPFILIATE_LIST_AFFILIATE_PROGRAMS` Tool to list all programs (affiliations) associated with a specific affiliate. Use when you need to see which programs an affiliate is enrolled in. ### List Affiliate Prospects **Slug:** `TAPFILIATE_LIST_AFFILIATE_PROSPECTS` Tool to list all affiliate prospects. Use when you need to retrieve prospects with optional filters by email, referral_code, program_id, or group_id. ### List all affiliates **Slug:** `TAPFILIATE_LIST_ALL_AFFILIATES` Tool to list all affiliates. Use after confirming API access to fetch affiliates with optional filters. ### List all balances **Slug:** `TAPFILIATE_LIST_BALANCES` Tool to list all outstanding affiliate balances. Use when you need to retrieve balance records for affiliates, typically before processing payments. ### List conversions **Slug:** `TAPFILIATE_LIST_CONVERSIONS` Tool to list all conversions. Use to fetch conversion records with optional filters for program, affiliate, date range, and pending status. ### List all customers **Slug:** `TAPFILIATE_LIST_CUSTOMERS` Tool to list all customers with optional filtering by program, customer ID, affiliate, or date range. Use after verifying API credentials to fetch customer records. ### List program affiliates **Slug:** `TAPFILIATE_LIST_PROGRAM_AFFILIATES` Tool to list all affiliates in a specific program. Use when you need to fetch affiliates enrolled in a particular program with optional filters for source_id, email, parent_id, or affiliate_group_id. ### List program bonuses **Slug:** `TAPFILIATE_LIST_PROGRAM_BONUSES` Tool to list all bonuses for a specific program. Use when you need to retrieve performance bonuses configured for a program. ### List program commission types **Slug:** `TAPFILIATE_LIST_PROGRAM_COMMISSION_TYPES` Tool to list commission types for a specific program. Use when you need to retrieve all commission types configured for a program after confirming valid API credentials. ### List program MLM levels **Slug:** `TAPFILIATE_LIST_PROGRAM_MLM_LEVELS` Tool to list MLM levels for a program. Use when you need to retrieve the multi-level marketing commission structure for a specific program. Returns empty array if no MLM levels are configured. ### Create a Payment **Slug:** `TAPFILIATE_PAYMENTS_CREATE_A_PAYMENT` Tool to create a payment. Use when you need to credit an affiliate after confirming transaction details. ### List all payments **Slug:** `TAPFILIATE_PAYMENTS_LIST_ALL_PAYMENTS` Tool to list all payments. Use when you need to retrieve paginated payment records after confirming API credentials. ### Retrieve a Payment **Slug:** `TAPFILIATE_PAYMENTS_RETRIEVE_A_PAYMENT` Tool to retrieve details of a specific payment. Use when you have the payment_id and need full payment information. ### List all payout methods **Slug:** `TAPFILIATE_PAYOUT_METHODS_LIST_ALL_PAYOUT_METHODS` Tool to retrieve a list of all payout methods for an affiliate. Use when fetching available payment options for an affiliate. ### List all programs **Slug:** `TAPFILIATE_PROGRAMS_LIST_ALL_PROGRAMS` Tool to list all programs. Use after confirming API credentials to fetch program list with optional asset filters. ### Remove affiliate group from affiliate **Slug:** `TAPFILIATE_REMOVE_AFFILIATE_GROUP` Tool to remove affiliate group from an affiliate. Use when you need to unassign an affiliate from their current group, setting their affiliate_group_id to null. ### Set Affiliate Group **Slug:** `TAPFILIATE_SET_AFFILIATE_GROUP` Tool to set the affiliate group for a specific affiliate. Use when you need to assign or change an affiliate's group membership. ### Set Affiliate Meta Data **Slug:** `TAPFILIATE_SET_AFFILIATE_META_DATA` Tool to update (replace) metadata for an affiliate. Use when you need to set custom metadata fields for a specific affiliate by their affiliate_id. ### Set Affiliate Metadata by Key **Slug:** `TAPFILIATE_SET_AFFILIATE_META_DATA_BY_KEY` Tool to set or update a specific metadata field for an affiliate by key. Use when you need to store custom data associated with an affiliate. ### Set Affiliate Parent **Slug:** `TAPFILIATE_SET_AFFILIATE_PARENT` Tool to set a parent affiliate relationship for a child affiliate. Use when you need to create a hierarchical affiliate structure by assigning a parent to a child affiliate. ### Update Affiliate Group **Slug:** `TAPFILIATE_UPDATE_AFFILIATE_GROUP` Tool to update an affiliate group's details. Use when you need to change the title or other properties of an existing affiliate group.