Skip to main content
GET
/
statements
/
users
/
{tenantUserId}
Get user statements timeline
curl --request GET \
  --url https://api.royalti.io/statements/users/{tenantUserId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/statements/users/{tenantUserId}"

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/users/{tenantUserId}', 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/users/{tenantUserId}",
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/users/{tenantUserId}"

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

url = URI("https://api.royalti.io/statements/users/{tenantUserId}")

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": {
    "Statements": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "TenantUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "periodStart": "2023-11-07T05:31:56Z",
        "periodEnd": "2023-11-07T05:31:56Z",
        "flags": {
          "onHold": true,
          "disputed": true
        },
        "gross": "<string>",
        "net": "<string>",
        "paidAmount": "<string>",
        "priorBalance": "<string>",
        "reportingCurrency": "USD",
        "frozenAt": "2023-11-07T05:31:56Z",
        "lastCalculatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "upcoming": [
      {}
    ],
    "statefulStatementsEnabled": true
  }
}
{
"status": "error",
"message": "Unauthorized"
}

Description

Get user statements timeline Chronological list of persisted Statement rows for one user. Self-or-admin guard: callers may request their own timeline; admins may request any user in the tenant. Ledger-fallback rows are NOT included — the timeline would need to enumerate every window the tenant has activity in (unbounded) to synthesize them. Use /statements/users/{id}/{start}/{end} for a specific window fallback. Authorization:
  • Required role: user or higher

Code Examples

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

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

response = requests.get(
  'https://api.royalti.io/statements/users/example-id',
)

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

Authorizations

Authorization
string
header
required

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

Path Parameters

tenantUserId
string<uuid>
required

Query Parameters

yearFilter
enum<string>
default:all
Available options:
all,
this-year,
last-12

Response

Timeline fetched.

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