Members
Workspace membership.
List workspace members with contact details and current roles.
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Query Parameters
page?Page
Range
1 <= valueDefault
1limit?Limit
Range
1 <= value <= 200Default
200Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/members"{ "data": [ { "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "display_name": "string", "email": "user@example.com", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "display_name": "string", "avatar_url": "string", "email": "user@example.com" }, "role": "OWNER", "joined_at": "2019-08-24T14:15:22Z" } ], "page": 0, "limit": 0, "total": 0}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "VALIDATION_FAILED", "details": { "errors": [ { "loc": [ "header", "Request-Id" ], "msg": "Field required", "type": "missing" } ] }, "message": "Request failed validation.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}Change a workspace member's role; an admin-capable key is required.
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Path Parameters
user_id*User Id
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Change a member's role.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/members/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "role": "OWNER" }'{ "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "display_name": "string", "email": "user@example.com", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "display_name": "string", "avatar_url": "string", "email": "user@example.com" }, "role": "OWNER", "joined_at": "2019-08-24T14:15:22Z"}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "VALIDATION_FAILED", "details": { "errors": [ { "loc": [ "header", "Request-Id" ], "msg": "Field required", "type": "missing" } ] }, "message": "Request failed validation.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}Remove a member and revoke every API key issued for that membership.
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Path Parameters
user_id*User Id
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/members/497f6eca-6276-4993-bfeb-53cbbbba6f08"Empty
{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "VALIDATION_FAILED", "details": { "errors": [ { "loc": [ "header", "Request-Id" ], "msg": "Field required", "type": "missing" } ] }, "message": "Request failed validation.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}{ "error": { "code": "NOT_FOUND", "message": "Deck not found.", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736" }}