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

url = "https://api.royalti.io/publisher-writer/agreements"

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-writer/agreements', 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-writer/agreements",
  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-writer/agreements"

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

url = URI("https://api.royalti.io/publisher-writer/agreements")

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",
    "tenantId": 123,
    "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "writerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "territories": [
      {
        "territoryCode": "WW",
        "prShare": 50,
        "mrShare": 50,
        "srShare": 50,
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z"
      }
    ],
    "contractNumber": "<string>",
    "contractDate": "2023-11-07T05:31:56Z",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isActive": true,
    "publisher": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "writer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]
{
  "message": "<string>",
  "error": "<string>"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

GET /publisher-writer/agreements Description: Returns agreements for the tenant matching the supplied filters, each with publisher and writer eagerly loaded (INNER JOIN — an agreement whose publisher or writer was hard-deleted will not appear). Not paginated — returns the full matching set as a bare array. Authorization:
  • Required role: user or higher
Method: GET

​
Code Examples

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

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

import requests

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

data = response.json()
print(data)

curl -X GET https://api.royalti.io/publisher-writer/agreements \
  -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>
​
writerId
string<uuid>
​
status
enum<string>
Available options:
draft,
pending,
active,
expired,
terminated
​
isActive
enum<string>

Compared as the literal string 'true'; any other value is treated as false.

Available options:
true,
false
​
startDate
string<date>

Matches agreements with startDate >= this date.

​
endDate
string<date>

Matches agreements with endDate <= this date.

Response

Agreements retrieved

​
id
string<uuid>
​
tenantId
integer
​
publisherId
string<uuid>
​
writerId
string<uuid>
​
name
string
​
description
string | null
​
territories
object[]
​
contractNumber
string | null
​
contractDate
string<date-time> | null
​
startDate
string<date-time> | null
​
endDate
string<date-time> | null
​
status
enum<string>
Available options:
draft,
pending,
active,
expired,
terminated
​
isActive
boolean
default:true
​
publisher
object

Only present when the record was loaded via the model's default scope (all reads; NOT present on the POST /agreements create response).

​
writer
object

Only present when the record was loaded via the model's default scope (all reads; NOT present on the POST /agreements create response).

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