Skip to main content
GET
/
user
/
invites
List workspace invites
curl --request GET \
  --url https://api.royalti.io/user/invites \
  --header 'Authorization: Bearer <token>'
{
  "totalItems": 1,
  "filteredItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "invites": [
    {
      "id": "e2d9b1ff-1db1-4c6f-86de-65c13716fd4d",
      "TenantUserId": "32dc2f99-934d-4e1d-8c51-46f573dbf9a2",
      "TenantId": 101,
      "status": "invited",
      "meta": {
        "message": "Welcome to the Royalti workspace.",
        "date": "2024-06-10T12:00:00.000Z"
      },
      "JoinedAt": null,
      "createdAt": "2024-06-10T12:00:00.000Z",
      "updatedAt": "2024-06-10T12:00:00.000Z",
      "TenantUser": {
        "id": "32dc2f99-934d-4e1d-8c51-46f573dbf9a2",
        "firstName": "Jane",
        "lastName": "Doe",
        "role": "admin",
        "User": {
          "email": "[email protected]"
        }
      }
    }
  ]
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Code Examples

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

​
status
enum<string>

Filter invitations by status

Available options:
invited,
joined,
cancelled
​
page
integer
default:1

Page number (used when size is provided)

Required range: x >= 1
​
size
integer
default:20

Number of invitations to return per page

Required range: 1 <= x <= 100

Response

Invitations retrieved successfully

​
totalItems
integer

Total invitations that match the filter

​
filteredItems
integer

Number of invitations returned in this page

​
totalPages
integer
​
currentPage
integer
​
invites
object[]