How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
FirstPromoter

FirstPromoter Referrals API

The Referrals API from FirstPromoter — 8 operation(s) for referrals.

Documentation Provider Profile APIs.io OpenAPI GitHub

FirstPromoter Referrals API is one of 30 APIs that FirstPromoter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Referrals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 12 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.firstpromoter.com/api/v2/affiliate, https://api.firstpromoter.com/api/v2/company.

12 operations 8 paths 11 schemas 2 DELETE3 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.firstpromoter.com/api/v2/company
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

FirstPromoter Referrals API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as ACCOUNT-ID (accountId). By default, every request must be authenticated.

  • BearerAuth — Access token passed as a Bearer token in the Authorization header
  • accountId — Your FirstPromoter Account ID. You can find this in the Settings → Integrations section of your dashboard.

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 3 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Referrals 12
GET
/referrals
Get available referrals
getReferrals 11 params → 200401403
POST
/referrals
Create referral
createReferral 1 param body → 200401403422
DELETE
/referrals
Delete referrals
1 param body → 200202401403
PUT
/referrals/{id}
Update referral
updateReferral 2 params body → 200401403
DELETE
/referrals/{id}
Delete referral
deleteReferral 2 params → 204401403
GET
/referrals/{id}
Get referral
3 params → 200401403404
GET
/referrals/export
Export referrals
exportReferrals 3 params → 200202401403
POST
/referrals/approve
Approve referrals
1 param body → 200202401403
POST
/referrals/disable
Disable referrals
1 param body → 200202401403
POST
/referrals/enable
Enable referrals
1 param body → 200202401403
POST
/referrals/move_to_promoter
Move referrals to promoter
1 param body → 200202401403422
POST
/referrals/{id}/import_events
Import previous sales from stripe
3 params → 202401403422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Referral_2 (18 properties), BatchOperationResponse (12 properties), Referral (8 properties), PromoterCampaign_2 (6 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties 2 required
Campaign
object
3 properties
PromoterCampaign
object
4 properties
Referral
object
8 properties
Promoter
object
3 properties
BatchOperationResponse
object
12 properties
Error_2
object
3 properties
Campaign_2
object
3 properties
PromoterCampaign_2
object
6 properties
Referral_2
object
18 properties
BatchSelectionRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firstpromoter-referrals-api-openapi.yml Raw ↑

Other APIs FirstPromoter publishes across the network.

FirstPromoter Asset Categories API
AE Profile APIs.io
FirstPromoter Assets API
AE Profile APIs.io
FirstPromoter Batch Processes API
AE Profile APIs.io
FirstPromoter Campaigns API
AE Profile APIs.io
FirstPromoter Cancellation API
AE Profile APIs.io
FirstPromoter Commissions API
AE Profile APIs.io
FirstPromoter Contract Documents API
AE Profile APIs.io
FirstPromoter Contracts API
AE Profile APIs.io
FirstPromoter Custom Referral Statuses API
AE Profile APIs.io
FirstPromoter Dashboards API
AE Profile APIs.io
FirstPromoter Email Settings API
AE Profile APIs.io
FirstPromoter Emails API
AE Profile APIs.io
#Referrals
← Back to F APIs
API Details
ID
firstpromoter:firstpromoter-referrals-api
Base URL
https://api.firstpromoter.com/api/v2/company
Docs
https://docs.firstpromoter.com/api-reference-v2/api-advanced/payout-methods-api
Provider
FirstPromoter
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=firstpromoter-referrals-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/firstpromoter-referrals-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of FirstPromoter Referrals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.