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

FirstPromoter Promoters API

FirstPromoter Promoters API - 13 operation(s) on the admin (api/v2/company) surface, from FirstPromoter's own published OpenAPI definition (3.0.1) indexed in https://docs.firstpromoter.com/llms.txt.

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

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

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

Requests are made against a single base URL, https://api.firstpromoter.com/api/v2/company.

13 operations 11 paths 11 schemas 3 GET9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
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 Promoters 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 se…
  • accountId — Your FirstPromoter Account ID. You can find this in the Settings → Integrations section of your dashboard.

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 3 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Promoters 13
GET
/promoters
Get available promoters
getPromoters 5 params → 200401
POST
/promoters
Create promoter
createPromoter 1 param body → 201401
GET
/promoters/{id}
Get promoter details
getPromoter 3 params → 200401
PUT
/promoters/{id}
Update promoter
updatePromoter 2 params body → 200401
GET
/promoters/{id}/chart_data
Get data used for chart
getPromoterChartData 5 params → 200401
POST
/promoters/accept
Accept promoters
acceptPromoters 1 param body → 200202401403422
POST
/promoters/reject
Reject promoters
rejectPromoters 1 param body → 200202401403422
POST
/promoters/block
Block promoters
blockPromoters 1 param body → 200202401403422
POST
/promoters/archive
Archive promoters
archivePromoters 1 param body → 200202401403422
POST
/promoters/move_to_campaign
Move promoters to campaign
movePromotersToCampaign 1 param body → 200202401403422
POST
/promoters/add_to_campaign
Add promoters to campaign
addPromotersToCampaign 1 param body → 200202401403422
POST
/promoters/assign_parent
Assign a parent promoter
acceptPromoters 1 param body → 200202401403422
POST
/promoters/restore
Restore promoters
restorePromoters 1 param body → 200202401403422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Promoter (23 properties), PromoterProfile (23 properties), PromoterListItem (22 properties), PromoterFilters (17 properties). Each schema is shown below with its type and property counts.

BatchOperationResponse
object
12 properties
ErrorResponse
object
2 properties
PromoterChartData
object
5 properties
Promoter
object
23 properties
PromoterListItem
object
22 properties
PromoterProfile
object
23 properties
PromoterCreate
object
6 properties 1 required
PromoterUpdate
object
7 properties
Ids
array
Array of promoter ids. If there are more than 5 ids on this param/field, the action will be processed asynchronously. The response for the batch status will mo…
PromoterFilters
object
17 properties
CustomFieldFilter
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firstpromoter-v2-promoters-openapi.yml Raw ↑

Other APIs FirstPromoter publishes across the network.

FirstPromoter Admin Payout Methods API
FirstPromoter Products API
FirstPromoter Affiliate Assets API
FirstPromoter Affiliate Campaigns API
FirstPromoter Affiliate Commissions API
FirstPromoter Affiliate Contract Documents API
FirstPromoter Affiliate Email Settings API
FirstPromoter Affiliate Payout Methods API
FirstPromoter Affiliate Payouts API
FirstPromoter Affiliate Promo Codes API
FirstPromoter Affiliate Promoter Campaigns API
FirstPromoter Affiliate Promoters API
Where this information came from

This is an independent, third-party profile of FirstPromoter Promoters 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.