AffiliateBase

AffiliateBase Referrals API

The Referrals API from AffiliateBase — 2 operation(s) for referrals.

GitHub OpenAPI

Operations 5

GET /api/v1/referrals List referrals #
POST /api/v1/referrals Create referral #
GET /api/v1/referrals/{id} Get referral #
PATCH /api/v1/referrals/{id} Update referral #
DELETE /api/v1/referrals/{id} Deactivate referral #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/affiliatebase-io/openapi/affiliatebase-io-referrals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/affiliatebase-io/json-schema/affiliatebase-io-campaign-write-schema.json
📊
JSONSchema
https://artifacts.apis.io/affiliatebase-io/json-schema/affiliatebase-io-affiliate-promo-code-schema.json
📊
JSONSchema
https://artifacts.apis.io/affiliatebase-io/json-schema/affiliatebase-io-coupon-schema.json
📊
JSONSchema
https://artifacts.apis.io/affiliatebase-io/json-schema/affiliatebase-io-referral-schema.json
📊
JSONSchema
https://artifacts.apis.io/affiliatebase-io/json-schema/affiliatebase-io-invitation-schema.json
📊
JSONSchema
https://artifacts.apis.io/affiliatebase-io/json-schema/affiliatebase-io-affiliate-schema.json

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/affiliatebase-io:affiliatebase-io-referrals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

affiliatebase-io-referrals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AffiliateBase API v1 Referrals API
  version: 1.0.0
  description: 'Source-aligned OpenAPI contract for AffiliateBase `/api/v1` endpoints.


    Authentication: one of Bearer token, Basic API key auth, or `X-Api-Key`.

    Account context: required via `account_id` query param or `X-Account-Id` header.

    Write endpoints accept JSON request bodies and Rails-style form-encoded parameters;

    responses are JSON encoded. List endpoints use consistent `data` and

    `pagination` envelopes.


    Rate limits: 45 requests per 30 seconds per credential and 180 per 30 seconds per

    IP address, applied before authentication. A throttled request returns HTTP `429`

    with error code `TOO_MANY_REQUESTS` and `RateLimit-Limit`, `RateLimit-Remaining`,

    `RateLimit-Reset`, and `Retry-After` headers (sent on `429` responses only).


    Error codes: `MISSING_ACCOUNT_ID` (400), `INVALID_PARAMETER` (400), `UNAUTHORIZED` (401),

    `FORBIDDEN` (403), `NOT_FOUND` (404), `VALIDATION_ERROR` (422), `TOO_MANY_REQUESTS` (429).

    Payout endpoints also return operation-specific `422` codes: `PAYOUT_EXECUTION_FAILED`,

    `PAYOUT_RUN_CREATE_FAILED`, `PAYOUT_RUN_EXECUTION_FAILED`, `PAYOUT_RUN_REMEDIATION_FAILED`,

    `PAYOUT_EXPORT_CREATE_FAILED`, `PAYOUT_EXPORT_DOWNLOAD_FAILED`, `PAYOUT_EXPORT_DELETE_FAILED`,

    and `PAYOUT_EXPORT_SETTLEMENT_FAILED`.'
servers:
- url: https://app.affiliatebase.io
security:
- bearerAuth: []
- basicAuth: []
- apiKeyAuth: []
tags:
- name: Referrals
paths:
  /api/v1/referrals:
    get:
      tags:
      - Referrals
      operationId: listReferrals
      summary: List referrals
      parameters:
      - $ref: '#/components/parameters/AccountIdQuery'
      - $ref: '#/components/parameters/AccountIdHeader'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Limit'
      - name: affiliate_id
        in: query
        schema:
          type: string
          format: uuid
      - name: conversion_state
        in: query
        schema:
          type: string
      - name: conversionState
        in: query
        schema:
          type: string
      - name: stripe_customer_id
        in: query
        schema:
          type: string
      - name: email
        in: query
        schema:
          type: string
          format: email
      - name: updated_since
        in: query
        schema:
          type: string
          format: date-time
      - name: updated_until
        in: query
        schema:
          type: string
          format: date-time
      - $ref: '#/components/parameters/Expand'
      - $ref: '#/components/parameters/ExpandBracket'
      responses:
        '200':
          description: Paginated referral list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedReferrals'
        '400':
          $ref: '#/components/responses/MissingAccountId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
    post:
      tags:
      - Referrals
      operationId: createReferral
      summary: Create referral
      parameters:
      - $ref: '#/components/parameters/AccountIdQuery'
      - $ref: '#/components/parameters/AccountIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - affiliate_id
              properties:
                affiliate_id:
                  type: string
                  format: uuid
                campaign_id:
                  type: string
                  format: uuid
                link_id:
                  type: string
                  format: uuid
                conversion_state:
                  type: string
                expires_at:
                  type: string
                  format: date-time
      responses:
        '201':
          description: Referral created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Referral'
        '400':
          $ref: '#/components/responses/MissingAccountId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
  /api/v1/referrals/{id}:
    get:
      tags:
      - Referrals
      operationId: getReferral
      summary: Get referral
      parameters:
      - $ref: '#/components/parameters/AccountIdQuery'
      - $ref: '#/components/parameters/AccountIdHeader'
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/Expand'
      - $ref: '#/components/parameters/ExpandBracket'
      responses:
        '200':
          description: Referral payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Referral'
        '400':
          $ref: '#/components/responses/MissingAccountId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - Referrals
      operationId: updateReferral
      summary: Update referral
      parameters:
      - $ref: '#/components/parameters/AccountIdQuery'
      - $ref: '#/components/parameters/AccountIdHeader'
      - $ref: '#/components/parameters/Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                conversion_state:
                  type: string
                deactivated_at:
                  type: string
                  format: date-time
                  description: Deactivates the referral. Sending `null` for an already deactivated referral returns `422`; reactivation is not supported.
                customer_email:
                  type: string
                  format: email
      responses:
        '200':
          description: Updated referral payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Referral'
        '400':
          $ref: '#/components/responses/MissingAccountId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
    delete:
      tags:
      - Referrals
      operationId: deactivateReferral
      summary: Deactivate referral
      parameters:
      - $ref: '#/components/parameters/AccountIdQuery'
      - $ref: '#/components/parameters/AccountIdHeader'
      - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: Referral deactivated
        '400':
          $ref: '#/components/responses/MissingAccountId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      required:
      - error
      - code
      properties:
        error:
          type: string
        code:
          type: string
        details:
          oneOf:
          - type: 'null'
          - type: object
            additionalProperties: true
          - type: array
            items:
              type: string
    Pagination:
      type: object
      required:
      - previous_page
      - current_page
      - next_page
      - count
      - limit
      - total_pages
      - total_count
      properties:
        previous_page:
          oneOf:
          - type: integer
          - type: 'null'
        current_page:
          type: integer
        next_page:
          oneOf:
          - type: integer
          - type: 'null'
        count:
          type: integer
        limit:
          type: integer
        total_pages:
          type: integer
        total_count:
          type: integer
    PaginatedReferrals:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Referral'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Referral:
      type: object
      properties:
        id:
          type: string
          format: uuid
        conversion_state:
          type: string
        attribution_method:
          type: string
          enum:
          - link
          - promo_code
          description: How the referral was attributed. `promo_code` when it came through an affiliate's code (a tracked visit with the code or a redemption at Stripe checkout), otherwise `link`.
        coupon_id:
          oneOf:
          - type: 'null'
          - type: string
            format: uuid
          description: The affiliate coupon the referral came through, when `attribution_method` is `promo_code`.
        expires_at:
          oneOf:
          - type: 'null'
          - type: string
            format: date-time
        deactivated_at:
          oneOf:
          - type: 'null'
          - type: string
            format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
    Expand:
      name: expand
      in: query
      schema:
        type: string
      description: Comma-delimited expand list.
    AccountIdHeader:
      name: X-Account-Id
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: Account context header. Required unless `account_id` query param is supplied.
    AccountIdQuery:
      name: account_id
      in: query
      required: false
      schema:
        type: string
        format: uuid
      description: Account context. Required unless `X-Account-Id` is supplied.
    ExpandBracket:
      name: expand[]
      in: query
      schema:
        type: array
        items:
          type: string
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
  responses:
    Forbidden:
      description: Authenticated but not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Forbidden
            code: FORBIDDEN
    MissingAccountId:
      description: Missing account context
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Account ID is required
            code: MISSING_ACCOUNT_ID
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not found
            code: NOT_FOUND
    ValidationError:
      description: Validation or state-transition error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Validation failed
            code: VALIDATION_ERROR
    TooManyRequests:
      description: API rate limit exceeded
      headers:
        RateLimit-Limit:
          schema:
            type: integer
          description: Maximum requests allowed in the current window.
        RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current window.
        RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the current rate limit window resets.
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many API requests. Please retry shortly.
            code: TOO_MANY_REQUESTS
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid API Secret.
            code: UNAUTHORIZED
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
    basicAuth:
      type: http
      scheme: basic
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key