curl --request GET \
--url https://dashboard.launchpointhq.com/api/v1/payouts/pending \
--header 'x-api-key: <api-key>'import requests
url = "https://dashboard.launchpointhq.com/api/v1/payouts/pending"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://dashboard.launchpointhq.com/api/v1/payouts/pending', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dashboard.launchpointhq.com/api/v1/payouts/pending",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dashboard.launchpointhq.com/api/v1/payouts/pending"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dashboard.launchpointhq.com/api/v1/payouts/pending")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.launchpointhq.com/api/v1/payouts/pending")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"contractId": "<string>",
"contractName": "<string>",
"amount": 123,
"amountCents": 123,
"originalAmount": 123,
"originalAmountCents": 123,
"currency": "<string>",
"status": "overdue",
"dueDate": "2023-11-07T05:31:56Z",
"isOverdue": true,
"isDue": true,
"programId": "<string>",
"programName": "<string>",
"creatorId": "<string>",
"creatorName": "<string>",
"creatorProfileImageUrl": "<string>",
"hasStripeAccount": true,
"deliveredPosts": 123,
"requiredPosts": 123,
"deliveryPercentage": 123,
"totalViews": 123,
"isProRata": true,
"paymentComponents": [
{}
],
"paymentStructure": {}
}
],
"page": 123,
"limit": 123,
"total": 123,
"totalPages": 123,
"summary": {
"totalPending": 123,
"totalAmount": 123,
"totalAmountCents": 123,
"overdueCount": 123,
"dueCount": 123,
"upcomingCount": 123,
"readyToPay": 123,
"needsSetup": 123
}
}View pending payouts
Get money currently held for creators in the payout reserve.
This is money already held for payment, not every unpaid creator amount or a complete list of pay terms. Use /pay-structures for creator and program pay terms.
curl --request GET \
--url https://dashboard.launchpointhq.com/api/v1/payouts/pending \
--header 'x-api-key: <api-key>'import requests
url = "https://dashboard.launchpointhq.com/api/v1/payouts/pending"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://dashboard.launchpointhq.com/api/v1/payouts/pending', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dashboard.launchpointhq.com/api/v1/payouts/pending",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dashboard.launchpointhq.com/api/v1/payouts/pending"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dashboard.launchpointhq.com/api/v1/payouts/pending")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.launchpointhq.com/api/v1/payouts/pending")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"contractId": "<string>",
"contractName": "<string>",
"amount": 123,
"amountCents": 123,
"originalAmount": 123,
"originalAmountCents": 123,
"currency": "<string>",
"status": "overdue",
"dueDate": "2023-11-07T05:31:56Z",
"isOverdue": true,
"isDue": true,
"programId": "<string>",
"programName": "<string>",
"creatorId": "<string>",
"creatorName": "<string>",
"creatorProfileImageUrl": "<string>",
"hasStripeAccount": true,
"deliveredPosts": 123,
"requiredPosts": 123,
"deliveryPercentage": 123,
"totalViews": 123,
"isProRata": true,
"paymentComponents": [
{}
],
"paymentStructure": {}
}
],
"page": 123,
"limit": 123,
"total": 123,
"totalPages": 123,
"summary": {
"totalPending": 123,
"totalAmount": 123,
"totalAmountCents": 123,
"overdueCount": 123,
"dueCount": 123,
"upcomingCount": 123,
"readyToPay": 123,
"needsSetup": 123
}
}Authorizations
API key created in Dashboard → Settings → Developer
Query Parameters
Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.
company, agency x <= 100Narrow results to a program
Narrow results to a creator
Limit results to creators who have a linked social account with exactly this handle, in any letter case. A leading @ is ignored. A handle that no visible creator linked returns an empty result. Use it when you know the handle but not the creatorId.
Minimum payout in dollars, with at most two decimal places
x >= 0Must be a multiple of 0.01amount, dueDate, creator asc, desc