Skip to main content
GET
/
publisher
/
sub-publishing
List sub-publishing agreements
curl --request GET \
  --url https://api.royalti.io/publisher/sub-publishing \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/publisher/sub-publishing"

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/publisher/sub-publishing', 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/publisher/sub-publishing",
  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/publisher/sub-publishing"

	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/publisher/sub-publishing")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/publisher/sub-publishing")

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
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "originalPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subPublisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": 123,
    "agreementNumber": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "terms": {
      "rightTypes": [],
      "shares": {},
      "retentionRate": 50,
      "territories": [
        "<string>"
      ],
      "exclusivity": true,
      "restrictions": [
        "<string>"
      ],
      "minimumGuarantee": {
        "amount": 123,
        "currency": "<string>"
      },
      "recoupmentTerms": {
        "recoupable": true,
        "recoupmentRate": 123,
        "crossCollateralization": true
      }
    },
    "originalPublisher": {},
    "subPublisher": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

GET /publisher/sub-publishing publisherId is optional — omitted, this returns every sub-publishing agreement for the tenant (the Sub-Publishing list page is tenant-wide). When provided, scopes to that publisher on the side indicated by type (original default, or sub). Authorization: user role + publisher addon.

​
Code Examples

const response = await fetch('https://api.royalti.io/publisher/sub-publishing', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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

import requests

response = requests.get(
  'https://api.royalti.io/publisher/sub-publishing',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)

curl -X GET https://api.royalti.io/publisher/sub-publishing \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
publisherId
string<uuid>
​
type
enum<string>
default:original

Only meaningful together with publisherId.

Available options:
original,
sub
​
status
enum<string>
Available options:
active,
inactive

Response

Agreements fetched (includes originalPublisher/subPublisher summaries), ordered by startDate DESC.

​
id
string<uuid>
​
originalPublisherId
string<uuid>
​
subPublisherId
string<uuid>
​
tenantId
integer
​
agreementNumber
string
​
startDate
string<date-time>
​
endDate
string<date-time> | null
​
terms
object
​
originalPublisher
object | null

Included on GET responses — { id, name, publisherType }.

​
subPublisher
object | null

Included on GET responses — { id, name, publisherType }.

​
createdAt
string<date-time>
​
updatedAt
string<date-time>