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

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

FirstPromoter Payouts API is one of 37 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 8 operations across 8 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

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

8 operations 8 paths 8 schemas 1 DELETE4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.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 8

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

Operations 8
GET
/payouts
Get all payouts
getAdminPayouts 19 params → 200401403
GET
/payouts/stats
Get payout stats
getAdminPayoutStats 6 params → 200401403422
GET
/payouts/due_stats
Get due payout stats
getAdminPayoutDueStats 4 params → 200401403
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 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Payout (17 properties), Error (2 properties), BatchActionResult (2 properties), PaymentsBatch (2 properties). Each schema is shown below with its type and property counts.

Payout
object
17 properties
PayoutStats
object
2 properties
PayoutDueStats
object
2 properties
PayoutsGroupedByPromoters
object
2 properties
PaymentsBatch
object
2 properties
BatchActionResult
object
2 properties
Ids
array
Array of Payout IDs
Error
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firstpromoter-v2-payouts-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 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.