Skip to main content
GET
/
publisher
/
publishers-with-user-data
List publishers merged with their linked TenantUser info
curl --request GET \
  --url https://api.royalti.io/publisher/publishers-with-user-data \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/publisher/publishers-with-user-data"

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/publishers-with-user-data', 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/publishers-with-user-data",
  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/publishers-with-user-data"

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

url = URI("https://api.royalti.io/publisher/publishers-with-user-data")

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,
    "name": "<string>",
    "ipiNameNumber": "<string>",
    "ipiBaseNumber": "<string>",
    "publisherType": "original",
    "affiliatedPRO": "<string>",
    "isActive": true,
    "settings": {
      "defaultCurrency": "USD",
      "paymentSchedule": "quarterly",
      "defaultTerritories": [
        "<string>"
      ],
      "defaultShares": {
        "pr": 123,
        "mr": 123,
        "sr": 123
      }
    },
    "territories": [
      {}
    ],
    "tenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "PublisherTerritories": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "TenantId": 123,
        "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "territoryCode": "US",
        "inclusionExclusion": "I",
        "prShare": 50,
        "mrShare": 50,
        "srShare": 50,
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "rights": [
          {
            "share": 123
          }
        ],
        "formula": "<string>",
        "postTermCollection": false,
        "agreementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "PublisherAgreements": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "TenantId": 123,
        "publisherId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "agreementNumber": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "terms": {
          "territories": [
            "WW"
          ],
          "excludedTerritories": [
            "<string>"
          ],
          "rightTypes": [],
          "shares": {
            "pr": 123,
            "mr": 123,
            "sr": 123
          },
          "minimumGuarantee": {
            "amount": 123
          }
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "userData": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "userInfo": {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>"
    },
    "ipiNameNumberSource": "user"
  }
]
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

GET /publisher/publishers-with-user-data Convenience list for frontend consumption: merges each publisher with userInfo (firstName/lastName/email) from its linked TenantUser, and backfills ipiNameNumber from the user’s ipi field when the publisher has none (flagged via ipiNameNumberSource: "user"). Not paginated. Ordered by name ASC. Authorization: user role + publisher addon.

​
Code Examples

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

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

import requests

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

data = response.json()
print(data)

curl -X GET https://api.royalti.io/publisher/publishers-with-user-data \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

​
Authorization
string
header
required

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

Response

Publishers fetched.

​
id
string<uuid>
​
tenantId
integer
​
name
string

1-45 characters (VALIDATION_RULES.publisher.name).

​
ipiNameNumber
string | null

11-digit IPI name number. Unique per tenant when set.

​
ipiBaseNumber
string | null

13-character IPI base number. Unique per tenant when set.

​
publisherType
enum<string>
default:original
Available options:
original,
sub,
administrator
​
affiliatedPRO
string | null
​
isActive
boolean
default:true
​
settings
object
​
territories
object[]

JSONB territory snapshot stored directly on the Publisher row. Distinct from the normalized PublisherTerritories table managed by the /territories endpoints.

​
tenantUserId
string<uuid> | null

Optional link to a TenantUser; when set and ipiNameNumber is absent, some read paths fall back to the linked user's IPI.

​
PublisherTerritories
object[]

Present on list/get responses (Sequelize include, unaliased plural).

​
PublisherAgreements
object[]

Present on GET /publishers/{id} and GET /publishers/me only.

​
userData
object | null

Linked TenantUser (id, firstName, lastName, email, ipi), present when tenantUserId is set.

​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
userInfo
object | null
​
ipiNameNumberSource
enum<string>

Present only when ipiNameNumber was backfilled from the linked TenantUser's ipi field.

Available options:
user