Skip to main content
GET
/
workspaces
/
{workspaceId}
/
invites
List Invites
curl --request GET \
  --url https://api.raydocs.com/workspaces/{workspaceId}/invites \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "email": "jsmith@example.com",
    "role": "admin",
    "status": "pending",
    "valid_until": "2023-11-07T05:31:56Z"
  }
]

​
Authentication & Scope

Requires the workspace-users-read ability.

​
Request

GET /workspaces/1/invites HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
workspaceIdintegerYesThe workspace ID

​
Response

200 OK – An array of pending invitations. 
[
  {
    "id": 1,
    "email": "pending@example.com",
    "role": "user",
    "status": "pending",
    "created_at": "2024-01-15T10:30:00Z"
  }
]

​
Status Values

StatusDescription
pendingInvitation sent, awaiting acceptance
expiredInvitation has expired

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
workspaceId
integer
required

Response

Successful

​
id
integer
​
email
string<email>
​
role
enum<string>
Available options:
admin,
user,
readonly
​
status
enum<string>
Available options:
pending,
accepted
​
valid_until
string<date-time>