> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.
# List workspace invites
> Returns recent invitations for the active workspace. Results include pending, joined, and cancelled invitations. When an invitation is cancelled the associated activation link is immediately revoked, so cancelled records are informational only.
This endpoint requires authentication. Include your Bearer token in the Authorization header.
## Code Examples
```javascript Node.js theme={null}
const response = await fetch('https://api.royalti.io/user/invites', {
method: 'GET',
headers: {
'Authorization': `Bearer ${token}`,
},
});
const data = await response.json();
console.log(data);
```
```python Python theme={null}
import requests
response = requests.get(
'https://api.royalti.io/user/invites',
headers={
'Authorization': f'Bearer {token}'
},
)
data = response.json()
print(data)
```
```bash cURL theme={null}
curl -X GET https://api.royalti.io/user/invites \
-H "Authorization: Bearer YOUR_TOKEN" \
```
## OpenAPI
````yaml get /user/invites
openapi: 3.0.0
info:
title: Royalti.io API
description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
version: 2.6.0
contact:
name: Royalti.io Support
email: support@royalti.io
url: https://royalti.io
license:
name: Proprietary
url: https://royalti.io/terms
servers:
- url: https://api.royalti.io
description: Production server
- url: https://api-dev.royalti.io
description: Development server
- url: http://localhost:8084
description: Local development
security:
- bearerAuth: []
tags:
- name: Accounting
description: Accounting and financial transaction operations
- name: DDEX
description: DDEX operations (ERN/MEAD, messages, delivery, providers)
- name: Label
description: Label management operations
- name: Internal Webhooks
description: Internal system webhooks for royalty processing and downloads
- name: Payment Webhooks
description: Payment processor webhook endpoints
- name: Billing Webhooks
description: Stripe billing and subscription webhooks
- name: Infrastructure Webhooks
description: Cloudflare domain and SSL webhooks
- name: Distribution Webhooks
description: Digital distribution platform webhooks (FUGA)
paths:
/user/invites:
get:
tags:
- Tenants
summary: List workspace invites
description: >-
Returns recent invitations for the active workspace. Results include
pending, joined, and cancelled invitations. When an invitation is
cancelled the associated activation link is immediately revoked, so
cancelled records are informational only.
parameters:
- in: query
name: status
schema:
type: string
enum:
- invited
- joined
- cancelled
description: Filter invitations by status
- in: query
name: page
schema:
type: integer
default: 1
minimum: 1
description: Page number (used when `size` is provided)
- in: query
name: size
schema:
type: integer
minimum: 1
maximum: 100
default: 20
description: Number of invitations to return per page
responses:
'200':
description: Invitations retrieved successfully
content:
application/json:
schema:
type: object
properties:
totalItems:
type: integer
description: Total invitations that match the filter
filteredItems:
type: integer
description: Number of invitations returned in this page
totalPages:
type: integer
currentPage:
type: integer
invites:
type: array
items:
type: object
properties:
id:
type: string
example: e2d9b1ff-1db1-4c6f-86de-65c13716fd4d
TenantUserId:
type: string
example: 32dc2f99-934d-4e1d-8c51-46f573dbf9a2
TenantId:
type: integer
example: 101
status:
type: string
enum:
- invited
- joined
- cancelled
example: invited
meta:
type: object
nullable: true
properties:
message:
type: string
example: Welcome to the Royalti workspace.
date:
type: string
example: '2024-06-10T12:00:00.000Z'
JoinedAt:
type: string
format: date-time
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
TenantUser:
type: object
properties:
id:
type: string
firstName:
type: string
lastName:
type: string
role:
type: string
example: admin
User:
type: object
properties:
email:
type: string
format: email
example:
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: jane.doe@example.com
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- bearerAuth: []
components:
schemas:
Error:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
code:
type: string
message:
type: string
details:
type: array
items:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
JWT Authorization header using the Bearer scheme. Format: "Bearer
{token}"
````