Skip to main content
GET
/
user
/
{id}
Get User
curl --request GET \
  --url https://api.royalti.io/user/{id} \
  --header 'Authorization: Bearer <token>'
{
  "fullName": "user2 Royalti",
  "phone": "+1234567890",
  "country": "Nigeria",
  "message": "Welcome to Royalti!",
  "sendEmail": true,
  "redirect_url": "https://app.royalti.io/welcome",
  "id": "b56fe67e-d1b9-4a04-9a13-c0a53be8da49",
  "firstName": "user2",
  "lastName": "Royalti",
  "email": "[email protected]",
  "ipi": "1234567890",
  "externalId": "123",
  "TenantUser": {
    "TenantId": 2,
    "nickName": "iEmmanuel104",
    "userType": [
      "Artist"
    ]
  },
  "invite": {
    "id": "e2d9b1ff-1db1-4c6f-86de-65c13716fd4d",
    "status": "invited",
    "date": "2024-06-10T12:00:00.000Z"
  }
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/user/ Description:
The /user/{userId} endpoint allows users to retrieve the details of a specific user identified by their unique userId. Method:
GET Path Parameter:
ParameterTypeDescription
userIdstringThe unique identifier of the user.
See Examples below for response

​
Code Examples

const response = await fetch('https://api.royalti.io/user/example-id', {
  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}"

Path Parameters

​
id
string
required

User ID

Response

success

​
fullName
string
​
id
string
​
firstName
string
​
lastName
string
​
email
string
​
ipi
string
​
externalId
string
​
TenantUser
object
​
invite
object