Skip to main content
GET
/
user
/
Get Users
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/user/ \
  --header 'Authorization: Bearer <token>'
{
  "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.

​
Code Examples

const response = await fetch('https://server26-dot-royalti-project.uc.r.appspot.com/user/', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
q
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

​
sort
enum<string>

Sort field

Available options:
createdAt,
updatedAt,
name,
split
​
order
string

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

​
role
string

This allows you filter by the users role, it can take multiple by comma separation

Response

Success

​
message
string
Example:

"success"

​
Users
object[]
​
count
integer

Number of users in current page

​
totalUsers
integer

Total number of users

​
accountingMetadata
object

Metadata about accounting calculations (when accounting=true)