Members endpoints
This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.
GET /api/workspaces/{workspaceId}/members
Section titled “GET /api/workspaces/{workspaceId}/members”| Parameter | In | Type | Required |
|---|---|---|---|
workspaceId |
path | string (uuid) | yes |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MembersResponse |
PATCH /api/workspaces/{workspaceId}/members/{memberUserId}
Section titled “PATCH /api/workspaces/{workspaceId}/members/{memberUserId}”| Parameter | In | Type | Required |
|---|---|---|---|
workspaceId |
path | string (uuid) | yes |
memberUserId |
path | string | yes |
Request body (application/json): ChangeMemberRoleRequest
| Field | Type | Required | Notes |
|---|---|---|---|
role |
string | yes |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MembershipDto |
DELETE /api/workspaces/{workspaceId}/members/{memberUserId}
Section titled “DELETE /api/workspaces/{workspaceId}/members/{memberUserId}”| Parameter | In | Type | Required |
|---|---|---|---|
workspaceId |
path | string (uuid) | yes |
memberUserId |
path | string | yes |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | none |
GET /api/workspaces/{workspaceId}/invitations
Section titled “GET /api/workspaces/{workspaceId}/invitations”| Parameter | In | Type | Required |
|---|---|---|---|
workspaceId |
path | string (uuid) | yes |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | array of InvitationDto |
POST /api/workspaces/{workspaceId}/invitations
Section titled “POST /api/workspaces/{workspaceId}/invitations”| Parameter | In | Type | Required |
|---|---|---|---|
workspaceId |
path | string (uuid) | yes |
Request body (application/json): CreateInvitationRequest
| Field | Type | Required | Notes |
|---|---|---|---|
email |
string | yes | |
role |
string | yes |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | IssuedInvitationDto |
201 |
Created | IssuedInvitationDto |
409 |
Conflict | ErrorResponse |
429 |
Too Many Requests | ErrorResponse |
DELETE /api/workspaces/{workspaceId}/invitations/{invitationId}
Section titled “DELETE /api/workspaces/{workspaceId}/invitations/{invitationId}”| Parameter | In | Type | Required |
|---|---|---|---|
workspaceId |
path | string (uuid) | yes |
invitationId |
path | string (uuid) | yes |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | none |
GET /api/invitations
Section titled “GET /api/invitations”| Status | Meaning | Body |
|---|---|---|
200 |
OK | array of MyInvitationDto |
POST /api/invitations/{invitationId}/open
Section titled “POST /api/invitations/{invitationId}/open”| Parameter | In | Type | Required |
|---|---|---|---|
invitationId |
path | string (uuid) | yes |
Request body (application/json): null or InvitationSecretRequest
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MyInvitationDto |
POST /api/invitations/{invitationId}/accept
Section titled “POST /api/invitations/{invitationId}/accept”| Parameter | In | Type | Required |
|---|---|---|---|
invitationId |
path | string (uuid) | yes |
Request body (application/json): null or InvitationSecretRequest
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MembershipDto |
POST /api/invitations/{invitationId}/decline
Section titled “POST /api/invitations/{invitationId}/decline”| Parameter | In | Type | Required |
|---|---|---|---|
invitationId |
path | string (uuid) | yes |
Request body (application/json): null or InvitationSecretRequest
| Status | Meaning | Body |
|---|---|---|
200 |
OK | none |