Tapfiliate

Tapfiliate Programs API

Manage affiliate programs and program affiliates

GitHub OpenAPI
Business capability
Channel Sales Management BC-410.60

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /programs/{program_id}/ Retrieve an affiliate program · Retrieve a Program #
Ask an LLM
“Can I look up the settings of one affiliate program?”
“What details does a single program record include?”
Tell an agent
Get program {program_id}.
Show me affiliate program {program_id}.
GET /programs/ List affiliate programs · List all programs #
Ask an LLM
“Which affiliate programs do I run in Tapfiliate?”
“Can I page through my programs?”
Tell an agent
List all my affiliate programs.
Show page {page} of programs, {limit} per page.
GET /programs/{program_id}/affiliates/ List affiliates in a program · List all affiliates in program #
Ask an LLM
“Who is enrolled in a particular affiliate program?”
“Can I page through the members of one program?”
Tell an agent
List the affiliates in program {program_id}.
Show page {page} of program {program_id}'s affiliates, {limit} per page.
POST /programs/{program_id}/affiliates/ Enroll an affiliate in a program · Add an affiliate to a program #
Ask an LLM
“How do I add an existing affiliate to another program?”
“Can I enroll an affiliate and pre-approve them at the same time?”
Tell an agent
Add affiliate {affiliate} to program {program_id}.
Enroll {affiliate} in program {program_id} with approved set to {approved}.
GET /programs/{program_id}/affiliates/{affiliate_id}/ Get an affiliate's program enrollment · Retrieve an affiliate in a program #
Ask an LLM
“What are an affiliate's coupon and referral link in a given program?”
“Can I see one affiliate's enrollment details for a specific program?”
Tell an agent
Get affiliate {affiliate_id}'s enrollment in program {program_id}.
Show how affiliate {affiliate_id} is set up in program {program_id}.
PATCH /programs/{program_id}/affiliates/{affiliate_id}/ Update an affiliate's program enrollment · Update an affiliate in a program #
Ask an LLM
“Can I assign a coupon code to an affiliate within a program?”
“How do I change an affiliate's referral link in one program?”
Tell an agent
Set the coupon for affiliate {affiliate_id} in program {program_id} to {coupon}.
Change affiliate {affiliate_id}'s referral link in program {program_id} to {referral_link}.
PUT /programs/{program_id}/affiliates/{affiliate_id}/approved/ Approve an affiliate in a program · Approve an affiliate #
Ask an LLM
“How do I approve an affiliate who applied to my program?”
“Can I accept an affiliate's pending enrollment?”
Tell an agent
Approve affiliate {affiliate_id} in program {program_id}.
Accept affiliate {affiliate_id}'s enrollment in program {program_id}.
DELETE /programs/{program_id}/affiliates/{affiliate_id}/approved/ Disapprove an affiliate in a program · Disapprove an affiliate #
Ask an LLM
“Can I reject or revoke an affiliate's place in a program?”
“What does disapproving an affiliate's enrollment do?”
Tell an agent destructive · confirm first
Disapprove affiliate {affiliate_id} in program {program_id}.
Revoke affiliate {affiliate_id}'s approval for program {program_id}.
GET /programs/{program_id}/commission-types/ List a program's commission types · List program commission types #
Ask an LLM
“Which commission types are available in a program?”
“What commission structures can I apply to conversions in this program?”
Tell an agent
List commission types for program {program_id}.
Show the commission types defined in program {program_id}.
GET /programs/{program_id}/levels/ List a program's MLM levels · List program MLM levels #
Ask an LLM
“How many multi-level marketing tiers does a program have?”
“What MLM levels are configured for this program?”
Tell an agent
List the MLM levels of program {program_id}.
Show multi-level commission tiers for program {program_id}.
GET /programs/{program_id}/bonuses/ List a program's bonuses · List program bonuses #
Ask an LLM
“Which bonus tiers can affiliates earn in a program?”
“Does this program offer any performance bonuses?”
Tell an agent
List bonuses for program {program_id}.
Show the bonus tiers set up in program {program_id}.

Documentation

📖
Documentation
https://tapfiliate.com/docs/rest/
📖
Authentication
https://tapfiliate.com/docs/rest/#authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/tapfiliate/openapi/tapfiliate-programs-api-openapi.yml

Other Resources

🔗
Overlay
https://artifacts.apis.io/tapfiliate/overlays/tapfiliate-programs-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tapfiliate:tapfiliate-programs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tapfiliate-programs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tapfiliate REST Programs API
  description: Tapfiliate is an affiliate tracking and management platform. This REST API allows you to create and manage affiliate programs, track conversions, manage affiliates, handle commission payouts, and record clicks. The API is versioned at V1.6 and uses API key authentication via the X-Api-Key header.
  version: '1.6'
  contact:
    name: Tapfiliate Support
    url: https://tapfiliate.com/docs/rest/
  termsOfService: https://tapfiliate.com/terms/
servers:
- url: https://api.tapfiliate.com/1.6
  description: Tapfiliate REST API v1.6
security:
- ApiKeyAuth: []
tags:
- name: Programs
  description: Manage affiliate programs and program affiliates
paths:
  /programs/{program_id}/:
    get:
      operationId: getProgram
      summary: Retrieve a Program
      description: Retrieve a single affiliate program by its ID.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '200':
          description: Program retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Program'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /programs/:
    get:
      operationId: listPrograms
      summary: List all programs
      description: Retrieve a paginated list of all affiliate programs.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: List of programs
          headers:
            Link:
              $ref: '#/components/headers/PaginationLink'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Program'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /programs/{program_id}/affiliates/:
    get:
      operationId: listProgramAffiliates
      summary: List all affiliates in program
      description: Retrieve all affiliates enrolled in a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: List of affiliates in program
          headers:
            Link:
              $ref: '#/components/headers/PaginationLink'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Affiliation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: addAffiliatToProgram
      summary: Add an affiliate to a program
      description: Enroll an affiliate in an affiliate program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - affiliate
              properties:
                affiliate:
                  type: object
                  required:
                  - id
                  properties:
                    id:
                      type: string
                      description: Affiliate ID
                approved:
                  type: boolean
                  description: Whether the affiliate is pre-approved
      responses:
        '201':
          description: Affiliate added to program
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Affiliation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /programs/{program_id}/affiliates/{affiliate_id}/:
    get:
      operationId: getProgramAffiliate
      summary: Retrieve an affiliate in a program
      description: Retrieve a specific affiliate's enrollment in a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      - $ref: '#/components/parameters/affiliateId'
      responses:
        '200':
          description: Affiliation retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Affiliation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateProgramAffiliate
      summary: Update an affiliate in a program
      description: Update an affiliate's enrollment details in a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      - $ref: '#/components/parameters/affiliateId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                coupon:
                  type: string
                referral_link:
                  type: string
      responses:
        '200':
          description: Affiliation updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Affiliation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /programs/{program_id}/affiliates/{affiliate_id}/approved/:
    put:
      operationId: approveAffiliate
      summary: Approve an affiliate
      description: Approve an affiliate's enrollment in a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      - $ref: '#/components/parameters/affiliateId'
      responses:
        '200':
          description: Affiliate approved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Affiliation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: disapproveAffiliate
      summary: Disapprove an affiliate
      description: Disapprove an affiliate's enrollment in a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      - $ref: '#/components/parameters/affiliateId'
      responses:
        '200':
          description: Affiliate disapproved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Affiliation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /programs/{program_id}/commission-types/:
    get:
      operationId: listProgramCommissionTypes
      summary: List program commission types
      description: List all commission types available for a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '200':
          description: Commission types
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CommissionType'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /programs/{program_id}/levels/:
    get:
      operationId: listProgramMLMLevels
      summary: List program MLM levels
      description: List multi-level marketing levels for a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '200':
          description: MLM levels
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    level:
                      type: integer
                    percentage:
                      type: number
                      format: float
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /programs/{program_id}/bonuses/:
    get:
      operationId: listProgramBonuses
      summary: List program bonuses
      description: List all bonus tiers for a program.
      tags:
      - Programs
      parameters:
      - $ref: '#/components/parameters/programId'
      responses:
        '200':
          description: Program bonuses
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    amount:
                      type: number
                      format: float
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    CommissionType:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - percentage
          - fixed
        percentage:
          type:
          - number
          - 'null'
          format: float
        amount:
          type:
          - number
          - 'null'
          format: float
    Program:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        currency:
          type: string
          description: ISO 4217 currency code
        cookie_time:
          type: integer
          description: Cookie lifetime in days
        default_landing_page_url:
          type: string
          format: uri
        incrementing_conversions:
          type: boolean
        recurring_commissions:
          type: boolean
    AffiliateRef:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
        firstname:
          type: string
        lastname:
          type: string
    Error:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message
    Affiliation:
      type: object
      description: An affiliate's enrollment in a program
      properties:
        affiliate:
          $ref: '#/components/schemas/AffiliateRef'
        program:
          type: object
          properties:
            id:
              type: string
            title:
              type: string
        approved:
          type: boolean
        coupon:
          type:
          - string
          - 'null'
        referral_link:
          type: string
          format: uri
        created_at:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: Authentication failed — missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnprocessableEntity:
      description: Validation error — request body is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 100
      description: Number of results per page
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number for pagination
    affiliateId:
      name: affiliate_id
      in: path
      required: true
      schema:
        type: string
      description: Affiliate ID
    programId:
      name: program_id
      in: path
      required: true
      schema:
        type: string
      description: Program ID
  headers:
    PaginationLink:
      description: Links to navigate between pages. Contains rel="next", rel="prev", rel="first", and rel="last" links as per RFC 5988.
      schema:
        type: string
      example: <https://api.tapfiliate.com/1.6/conversions/?page=3>; rel="next", <https://api.tapfiliate.com/1.6/conversions/?page=51>; rel="last"
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
x-provenance:
  method: harvested
  publisher: Tapfiliate
  source: https://developers.tapfiliate.com/api-reference/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)