Skip to main content
GET
/
statements
/
publisher
Cross-publisher statements list
curl --request GET \
  --url https://api.royalti.io/statements/publisher \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/statements/publisher"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/statements/publisher', 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://api.royalti.io/statements/publisher",
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://api.royalti.io/statements/publisher"

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://api.royalti.io/statements/publisher")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/statements/publisher")

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
{
  "message": "<string>",
  "data": {
    "PublisherStatements": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tenantId": 123,
        "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "periodStart": "2023-12-25",
        "periodEnd": "2023-12-25",
        "currency": "USD",
        "totalAmount": 123,
        "metadata": {},
        "Publisher": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "count": 123,
    "totalItems": 123,
    "totalPages": 123,
    "currentPage": 123
  }
}
{
"status": "error",
"message": "Unauthorized"
}

Description

Cross-publisher PublisherStatement list Lists PublisherStatement rows across ALL publishers for the active tenant (Phase 2 backfill). Distinct from the per-user Statement roster documented throughout the rest of this file — this reads the publisher-royalty-statement resource whose per-publisher CRUD and reconciliation surface lives at /publisher/publishers/{id}/statements/... (see publishers.yaml). Registered as /statements/publisher (not nested under /publisher/...) because it belongs to the statementRoutes router, mounted at /statements. Requires an active publisher add-on for the tenant (checkAddon('publisher')) in addition to the admin role. Authorization:
  • Required role: admin or higher

Code Examples

const response = await fetch('https://api.royalti.io/statements/publisher', {
  method: 'GET',
});

const data = await response.json();
console.log(data);
import requests

response = requests.get(
  'https://api.royalti.io/statements/publisher',
)

data = response.json()
print(data)
curl -X GET https://api.royalti.io/statements/publisher \

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

publisherId
string<uuid>
status
enum<string>

Single status or comma-separated list.

Available options:
draft,
pending,
approved,
paid
currency
string
Example:

"USD"

periodStart
string<date>

Inclusive lower bound on periodStart.

periodEnd
string<date>

Inclusive upper bound on periodEnd.

page
integer
size
integer

Default 20, max 100.

Response

Statements fetched, ordered by periodStart DESC. Omit page/size for the unpaginated { count, PublisherStatements } shape.

Every statements response wraps the payload in { status, message, data }. data carries the per-endpoint payload PLUS the per-tenant feature flag.

status
enum<string>
Available options:
success,
error
message
string
data
object