FirstPromoter Referrals API
FirstPromoter Referrals API - 10 operation(s) on the admin (api/v2/company) surface, from FirstPromoter's own published OpenAPI definition (3.0.0) indexed in https://docs.firstpromoter.com/llms.txt.
FirstPromoter Referrals API is one of 37 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 10 operations across 7 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://api.firstpromoter.com/api/v2/company.
Metadata
The identity and technical contract details declared by the specification.
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— API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations →…accountId— Your FirstPromoter Account ID. You can find this in the Settings → Integrations section of your dashboard.
Paths & Operations 10
Across 7 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Referral (18 properties), BatchOperationResponse (12 properties), Filters (10 properties), PromoterCampaign (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from FirstPromoter 12
Other APIs FirstPromoter publishes across the network.
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.