The Workspace API provides operations for managing workspace information, appearance, regional settings, members, and workspace lifecycle actions.
Workspace-authenticated requests require an Auth0 Bearer JWT and the workspace context required by the endpoint.
Endpoints
| Method | Path | Purpose |
| GET | /auth/members | List Workspace members |
| POST | /auth/request-access | Request elevated access |
| GET | /auth/appearance | Get Workspace appearance |
| PATCH | /auth/appearance | Update Workspace appearance |
| GET | /auth/languages | List supported languages |
| PATCH | /auth/Workspace/identity | Update company identity |
| PATCH | /auth/Workspace/details | Update Workspace details |
| PATCH | /auth/Workspace/language-region | Update regional settings |
| PATCH | /auth/Workspace/timezone | Update the workspace timezone and business-hours configuration.Feature Gate: operational_hoursMinimum plan: GROWTHRequired role: OWNER |
| GET | /auth/workspace/check-name | Check Workspace name availability |
| POST | /auth/Workspace/new | Create another Workspace |
| POST | /auth/Workspace/logo | Upload Workspace logo |
| DELETE | /auth/Workspace | Schedule Workspace deletion |
| POST | /auth/Workspace/:workspaceId/restore | Restore deleted Workspace |
The audit confirms Workspace endpoints use role and permission guards depending on the operation.
Example — List Workspace Members
GET /auth/members?page=0&pageSize=20
Authorization: Bearer <AUTH0_ACCESS_TOKEN>
x-workspace-id: <WORKSPACE_ID>
Supported filters include search, roles, status, onlineStatus, and sort.
Workspace Identity
The Workspace identity endpoint accepts:
{
“workspaceName”: “Example Workspace”,
“website”: “https://example.com”,
“supportEmail”: “support@example.com”
}
Need Help?
Email: support@ysdesk.com
Documentation: https://docs.ysplugins.com/ys-desk