Get started

Workspaces Team

API endpoints for Workspaces Team

GET /api/workspaces/{workspace_id}/team

List

Response Codes

Status Code Description
200 Success
GET /api/workspaces/{workspace_id}/team/invitations

ListInvitations

Response Codes

Status Code Description
200 Success
POST /api/workspaces/{workspace_id}/team/invite

Send sends an email invitation to join the workspace.

Creates a pending invitation and sends an email to the specified address with a unique invitation link. Returns 409 if the email belongs to an existing member or already has a pending invitation.

Response Codes

Status Code Description
201 Resource created successfully
400 Invalid request

Resource created successfully

Response response.InvitationResponse

Invitation

Property Type Description
id integer (int64) Unique invitation identifier
workspace_id integer (int64) ID of workspace for this invitation
email string Invited user's email address
role string Role to be assigned: admin or member
status string Invitation status: pending, accepted, or expired
expires_at string (date-time) Timestamp when invitation expires
created_at string (date-time) Timestamp when invitation was created
invited_by string | null User who sent the invitation
POST /api/workspaces/{workspace_id}/team/transfer

Transfer

Response Codes

Status Code Description
200 Success
PATCH /api/workspaces/{workspace_id}/team/members/{member_id}

Update

Response Codes

Status Code Description
200 Success
DELETE /api/workspaces/{workspace_id}/team/invitations/{invitation_id}

Revoke revokes a pending invitation.

Cancels a pending invitation, preventing the recipient from accepting it. Returns 404 if invitation not found or already accepted/expired.

Response Codes

Status Code Description
204 Success with no content
400 Invalid request
404 Resource not found
500 Internal server error
DELETE /api/workspaces/{workspace_id}/team/members/{member_id}

Remove

Response Codes

Status Code Description
200 Success