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 Payouts API

The Payouts API from FirstPromoter — 10 operation(s) for payouts.

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

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

This API exposes 10 operations across 10 paths, and defines 12 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.

10 operations 10 paths 12 schemas 1 DELETE5 GET4 POST

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 Payouts 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 — Account ID required with bearer token

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Payouts 10
GET
/payouts
Get all payouts
10 params → 200401403
GET
/payouts/due_stats
Get due payout stats
1 param → 200401403
GET
/payouts/export
Export payouts
3 params → 200202401403422
POST
/commissions/generate_payouts
Generate payouts for commissions
generatePayouts 1 param body → 200401
GET
/payouts/stats
Get payout stats
getAdminPayoutStats 6 params → 200401403422
GET
/payouts/group_by_promoters
Get all payouts grouped by promoters
getAdminPayoutsGroupedByPromoters 7 params → 200401403
POST
/payouts/create_payments_batch
Create payments batch
createPaymentsBatch 1 param body → 201401403422
POST
/payouts/mark_as_paid
Mark payouts as paid
markPayoutsAsPaid 1 param body → 200202401403422
POST
/payouts/mark_as_unpaid
Mark payouts as unpaid
markPayoutsAsUnpaid 1 param body → 200202401403422
DELETE
/payouts/destroy
Delete payouts
deletePayouts 1 param body → 200202401403422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Payout_2 (17 properties), Payout (17 properties), PayoutMeta (8 properties), PayoutStats (5 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties
Payout
object
17 properties
PayoutStats
object
5 properties
PayoutMeta
object
8 properties
BatchActionResult
object
2 properties
PaymentsBatch
object
2 properties
Error_2
object
2 properties 2 required
PayoutsGroupedByPromoters
object
2 properties
Payout_2
object
17 properties
PayoutStats_2
object
2 properties
PayoutDueStats
object
2 properties
Ids
array
Array of Payout IDs

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firstpromoter-payouts-api-openapi.yml Raw ↑

Other APIs FirstPromoter publishes across the network.

FirstPromoter Asset Categories API
FirstPromoter Assets API
FirstPromoter Batch Processes API
FirstPromoter Campaigns API
FirstPromoter Cancellation API
FirstPromoter Commissions API
FirstPromoter Contract Documents API
FirstPromoter Contracts API
FirstPromoter Custom Referral Statuses API
FirstPromoter Dashboards API
FirstPromoter Email Settings API
FirstPromoter Emails API
Where this information came from

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