Get Users - Royalti.io API

Get Users

curl --request GET \
  --url https://api.royalti.io/user/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/user/', 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/user/",
  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/user/"

	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))

}

require 'uri'
require 'net/http'

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

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": "success",
  "Users": [
    {
      "fullName": "Royal Records",
      "email": "royal@royalti.io",
      "id": "eec29e6f-b567-4ca4-befe-658743058098",
      "firstName": "Royal",
      "lastName": "Records",
      "role": "user",
      "externalId": "2892",
      "country": "Åland Islands",
      "createdAt": "2022-02-26T04:38:21.560Z",
      "updatedAt": "2024-03-22T11:10:53.519Z",
      "User": {
        "email": "royal@royalti.io"
      },
      "Artists": [
        {
          "id": "2fca1b81-2f97-4b02-92a2-899d17c756b8",
          "artistName": "Young Blud"
        }
      ]
    }
  ],
  "count": 1,
  "totalUsers": 1
}

GET

user

Get Users

curl --request GET \
  --url https://api.royalti.io/user/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/user/', 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/user/",
  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/user/"

	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))

}

require 'uri'
require 'net/http'

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

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": "success",
  "Users": [
    {
      "fullName": "Royal Records",
      "email": "royal@royalti.io",
      "id": "eec29e6f-b567-4ca4-befe-658743058098",
      "firstName": "Royal",
      "lastName": "Records",
      "role": "user",
      "externalId": "2892",
      "country": "Åland Islands",
      "createdAt": "2022-02-26T04:38:21.560Z",
      "updatedAt": "2024-03-22T11:10:53.519Z",
      "User": {
        "email": "royal@royalti.io"
      },
      "Artists": [
        {
          "id": "2fca1b81-2f97-4b02-92a2-899d17c756b8",
          "artistName": "Young Blud"
        }
      ]
    }
  ],
  "count": 1,
  "totalUsers": 1
}

This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Description: The /user/ endpoint retrieves user data with optional accounting information from cached data. Authorization:

Required role: admin or higher

Enhanced Accounting Support: When accounting=true, this endpoint now provides:

95% faster performance: 10-50ms response vs previous 500-2000ms BigQuery approach
Cached accounting data: Returns Gross, Paid, Due values from UserAccounting table
Background processing: Automatically queues calculation for users without cached data
Transparent operations: Response includes metadata about cache status and queued calculations

Method: GET Query Parameters:

Parameter	Type	Description
q (Optional)	string	Search query to filter users by name or email
page (Optional)	integer	Page number for pagination. Default: 1
size (Optional)	integer	Number of users per page. Default: 10
accounting (Optional)	string	Set to ‘true’ to include fast cached accounting data
attributes (Optional)	string	Comma-separated list of attributes to include
sort (Optional)	string	Sort field: ‘createdAt’, ‘updatedAt’, ‘name’, ‘split’
order (Optional)	string	Sort order: ‘asc’ or ‘desc’
externalId (Optional)	string	Filter by external ID
role (Optional)	string	Filter by user role(s), comma-separated for multiple

Performance Notes:

Without accounting: Standard user list response
With accounting=true: Includes cached Gross, Paid, Due values with 95% faster performance
Users without cache: Return zeros with pendingCalculation: true and get queued for background processing

Code Examples

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

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

import requests

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

data = response.json()
print(data)

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

Authorizations

Authorization

string

header

required

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

Query Parameters

string

Search query to filter users

page

string

Page number for pagination

size

string

Number of users per page

accounting

enum<string>

Set to 'true' to include fast cached accounting data

Available options:

true,

false

attributes

string

Comma-separated list of attributes to include in the response

externalId

string

Filter users by external ID

role

string

Filter by user role(s), comma-separated for multiple

sort

enum<string>

Sort field (using accounting fields like 'gross', 'paid', 'due' requires accounting=true)

Available options:

createdAt,

updatedAt,

name,

split,

gross,

paid,

due

order

enum<string>

default:desc

this value determines the order for sorting the result, either ascending or descending

Available options:

asc,

desc

hasEmail

enum<string>

Filter users by email presence. true = users with linked User account, false = users without

Available options:

true,

false

hasPaymentSettings

enum<string>

Filter users by payment settings. true = users with payment method, false = users without

Available options:

true,

false

hasArtists

enum<string>

Filter users by artist linkage. true = users linked to artists, false = users not linked

Available options:

true,

false

Response

Success

message

string

Example:

"success"

Users

object[]

Show child attributes

count

integer

Number of users in current page

totalUsers

integer

Total number of users

accountingMetadata

object

Metadata about accounting calculations (when accounting=true)

Show child attributes

​Description

​Code Examples

Authorizations

Query Parameters

Response

Description

Code Examples