Skip to main content
GET
/
publishing
/
claims
List claims for the tenant inbox
curl --request GET \
  --url https://api.royalti.io/publishing/claims \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/publishing/claims"

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

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

url = URI("https://api.royalti.io/publishing/claims")

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
{
  "status": "success",
  "data": {
    "rows": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tenantId": 123,
        "workId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "claimantWriterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "claimantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "claimedShares": {
          "pr": 123,
          "mr": 123,
          "sr": 123
        },
        "evidenceUrls": [
          "<string>"
        ],
        "resolution": {
          "reason": "<string>",
          "resolvedById": "<string>",
          "resolvedAt": "2023-11-07T05:31:56Z"
        },
        "parentClaimId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "count": 123,
    "summary": {
      "open": 123,
      "under_review": 123,
      "escalated": 123,
      "resolved_this_month": 123
    },
    "totalItems": 123,
    "totalPages": 123,
    "currentPage": 123
  }
}
{
"status": "error",
"message": "<string>",
"code": "<string>",
"details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /publishing/claims Description: Filtered, paginated tenant-wide claims list plus a status summary for dashboard counters. page defaults to 1, size defaults to 20 and is capped at 100. Authorization:
  • Required role: user or higher
  • Requires an active publisher addon
Method: GET

Code Examples

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

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

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

data = response.json()
print(data)
curl -X GET https://api.royalti.io/publishing/claims \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>
Available options:
filed,
under_review,
counter_claimed,
resolved,
escalated,
withdrawn
claimType
enum<string>
Available options:
ownership,
share_dispute,
registration_conflict,
metadata
workId
string<uuid>
claimantWriterId
string<uuid>
page
integer
default:1
size
integer
default:20
Required range: x <= 100

Response

Claims retrieved

status
string
Example:

"success"

data
object