Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

FirstPromoter (BYOK) — connector documentation

  • MCP endpoint: https://byok-firstpromoter.connectorbay.com/mcp
  • REST API: POST https://byok-firstpromoter.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-firstpromoter.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own FirstPromoter API key (Settings, Integrations, Manage API Keys), sent in the X-Upstream-Key header and the Account ID (Settings, Integrations) in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-firstpromoter.connectorbay.com/health · Tool schemas: https://byok-firstpromoter.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-firstpromoter · agent@connectorbay.com

What FirstPromoter (BYOK) is for

FirstPromoter (BYOK) lets an AI assistant read your own FirstPromoter data through the FirstPromoter API with a key you supply (API key (Settings, Integrations, Manage API Keys)). Read-only: 9 tools (list_promoters, get_promoter, list_referrals, get_referral, list_commissions, list_payouts, get_due_payout_stats, list_promoter_campaigns, list_promo_codes). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.firstpromoter.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by FirstPromoter. FirstPromoter and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Who are my top FirstPromoter promoters?"
  • "Show FirstPromoter promoter 1234"
  • "Which FirstPromoter referrals became active customers?"
  • "Show FirstPromoter referral for email jane@example.com"
  • "Which FirstPromoter commissions are still pending approval?"
  • "Which FirstPromoter payouts are pending?"

What it does

  • list_promoters: List promoters (affiliates) with click, referral, customer, sale and revenue totals, optionally searched by email, name or reference id.
  • get_promoter: Get one promoter by numeric id, or by email, customer id or promo code with find_by.
  • list_referrals: List referrals (leads and customers brought in by promoters) with state, promoter and campaign, optionally filtered by type, state, promoter or creation dates.
  • get_referral: Get one referral by numeric id, or by email, uid or username with find_by.
  • list_commissions: List commissions with status, amount, sale amount, paid flag, promoter, campaign and referral. Amounts are in the smallest currency unit of the account.
  • list_payouts: List payouts with status, amount, period, payout method, promoter and campaign, optionally by status, promoter or whether they are payable.
  • get_due_payout_stats: Show how many promoters and how much money fall in the next, overdue and custom payout periods, with the payout cycle settings.
  • list_promoter_campaigns: List the links between promoters and campaigns (which promoter promotes which campaign).
  • list_promo_codes: List promo codes with the reward they grant, the promoter campaign they belong to and archive time.

BYOK key

You bring your own FirstPromoter API key (Settings, Integrations, Manage API Keys) (https://firstpromoter.com/settings/integrations). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.firstpromoter.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the FirstPromoter API (api.firstpromoter.com) with a BYOK key; documentation: https://docs.firstpromoter.com/api-reference-v2/api-admin/introduction. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by FirstPromoter. FirstPromoter and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your FirstPromoter account.

Built for: Worldwide. Languages: English.