Workspace API

The Workspace API allows you to manage workspace settings, RBAC status, and monitor background jobs.

Base Endpoint

All workspace endpoints use the base path:

/v1/workspaces/{workspaceId}

Authentication

All workspace API endpoints require API key authentication. See the Authentication guide for details on generating access tokens.

Available Endpoints

Workspace Management

Common Use Cases

Enable RBAC for Your Workspace

curl -X PUT \
  'https://api.sharely.ai/v1/workspaces/{workspaceId}/rbac-status' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'organizationid: your-organization-id' \
  -d '{
    "rbacStatus": "ACTIVE"
  }'

Check Background Job Status

curl -X POST \
  'https://api.sharely.ai/v1/workspaces/{workspaceId}/background-jobs' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'organizationid: your-organization-id' \
  -d '{
    "jobIds": ["job-uuid-1", "job-uuid-2"]
  }'

Next Steps