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

​
List Workspace Invites

Retrieve all pending or accepted invitations for a workspace.

​
Authentication & Scope

Requires workspace-users-read ability. The requester must be a member of the workspace.

​
Request

GET /open/workspaces/{workspaceId}/invites HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeDescription
workspaceIdnumberID of the workspace.

​
Response

200 OK – Array of Invite objects. 
[
  {
    "id": 55,
    "email": "[email protected]",
    "role": "user",
    "status": "pending",
    "valid_until": "2024-06-25T23:59:59Z"
  }
]
403 Forbidden – Token lacks workspace-users-read or you lack access.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
workspaceId
string
required

Response

Successful

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

Expiration timestamp for the invite