curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown', 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://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"error": "<string>",
"breakdown": {
"totalAmount": 123,
"components": [
{
"type": "<string>",
"name": "<string>",
"baseAmount": 123,
"calculation": "<string>",
"details": "<string>",
"postId": "<string>",
"milestone": 123,
"isAggregate": true
}
],
"constraints": [
{
"type": "<string>",
"name": "<string>",
"value": "<unknown>",
"applied": true,
"impact": "<string>"
}
],
"metadata": {
"paymentType": "<string>",
"paymentSource": "<string>",
"cycle": {
"start": "<string>",
"end": "<string>",
"deliveredPosts": 123,
"totalViews": 123,
"billableViews": 123
}
}
},
"contract": {
"id": "<string>",
"contractorName": "<string>",
"position": "<string>"
},
"program": {
"id": "<string>",
"name": "<string>",
"emoji": "<string>"
},
"postsInCycle": [
{}
],
"lineItems": [
{}
],
"contractorId": "<string>",
"socialProfiles": [
{
"platform": "<string>",
"handle": "<string>"
}
],
"isCustomPayout": true,
"note": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Get payout breakdown
payment-breakdown details for a historical (or in-progress) payout of a contract. Requires the payouts:read scope.
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown', 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://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/payouts/contracts/{id}/breakdown")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"error": "<string>",
"breakdown": {
"totalAmount": 123,
"components": [
{
"type": "<string>",
"name": "<string>",
"baseAmount": 123,
"calculation": "<string>",
"details": "<string>",
"postId": "<string>",
"milestone": 123,
"isAggregate": true
}
],
"constraints": [
{
"type": "<string>",
"name": "<string>",
"value": "<unknown>",
"applied": true,
"impact": "<string>"
}
],
"metadata": {
"paymentType": "<string>",
"paymentSource": "<string>",
"cycle": {
"start": "<string>",
"end": "<string>",
"deliveredPosts": 123,
"totalViews": 123,
"billableViews": 123
}
}
},
"contract": {
"id": "<string>",
"contractorName": "<string>",
"position": "<string>"
},
"program": {
"id": "<string>",
"name": "<string>",
"emoji": "<string>"
},
"postsInCycle": [
{}
],
"lineItems": [
{}
],
"contractorId": "<string>",
"socialProfiles": [
{
"platform": "<string>",
"handle": "<string>"
}
],
"isCustomPayout": true,
"note": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Path Parameters
The id.
Query Parameters
Epoch-ms start of a historical cycle to look up. Omit to compute the current breakdown.
Response
The payment-breakdown details for the contract's payout.
Payment-breakdown details for a historical (or in-progress) payout of a contract. When no payment structure is found, breakdown is null and an error field is present. The exact field set varies by code path (live compute vs stored-ledger vs deleted-contract fallback); only the stable top-level fields are documented.
Show child attributes
Show child attributes