Skip to main content
POST
/
api
/
v3
/
instance
/
workspaces
/
{id}
/
members
Add a member to a workspace
curl --request POST \
  --url https://paradigm-preprod.lighton.ai/api/v3/instance/workspaces/{id}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "owner"
}
'
{
  "users": [
    {
      "id": 123,
      "email": "<string>",
      "role": "<string>"
    }
  ],
  "groups": [
    {
      "id": 123,
      "name": "<string>",
      "role": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Body

V3 API: Request serializer for adding a member to a workspace (admin-only endpoint)

role
enum<string>
required
  • owner - Owner
  • editor - Editor
  • viewer - Viewer
Available options:
owner,
editor,
viewer
user_id
integer
group_id
integer

Response

Member added successfully

V3 Response serializer for workspace members.

users
object[]
required
groups
object[]
required