Workspaces - Get All Yours
Retrieve the list of workspaces for the authenticated user.
GET /workspaces
Request Headers |
Authorization: Bearer <token> |
Query Parameters |
offset: integer (optional) |
limit: integer (optional) |
Success Response |
HTTP/1.1 200 OK { "workspaces": [ { // Workspace information }, { // Workspace information }, ... ] } |
Workspaces - Get by ID
Retrieve information about a specific workspace.
GET /workspaces/{uuid}Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string |
Success Response |
HTTP/1.1 200 OK { "workspace": { // Workspace information } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Workspaces - Update
Update a specific workspace.
PUT /workspaces/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Request Body |
{ "workspace": { "uuid": "string (required)", "name": "string (optional)", "userDisplayName": "string (optional)", "userEmail": "string (optional)", "userPrefs": "JSON (optional)" } } |
Success Response |
HTTP/1.1 200 OK { "workspace": { // Updated workspace information } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Tenants - Get by ID
Retrieve information about a specific tenant.
GET /tenants/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 200 OK { "tenant": { // Tenant information } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Tenants - Get Owners
Retrieve the owners of a specific tenant.
GET /tenants/:uuid/owners
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 200 OK { "workspaces": [ // List of workspace objects ] } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Tenants - Update
Update the details of a specific tenant.
PUT /tenants/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Request Body |
{ "tenant": { "uuid": "string", "name": "string" } } |
Success Response |
HTTP/1.1 200 OK { "tenant": { // Updated tenant object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |