Skip to main content

Get Workspace (v1)

Get a single workspace by ID.

Method & Path​

GET /v1/admin/workspaces/:workspaceId

Description​

Retrieves detailed information about a specific workspace by its ID.

Authentication​

Required: Admin authentication with businesses.manage permission.

Include the admin JWT token in the Authorization header:

Authorization: Bearer <admin_token>

Headers​

Authorization: Bearer <admin_token>
Content-Type: application/json

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesThe workspace ID

Query Parameters​

None.

Request Body​

None.

Response 200 OK​

{
  "workspace": {
    "id": "507f1f77bcf86cd799439011",
    "name": "Example Workspace",
    "email": "workspace@example.com",
    "planId": "507f1f77bcf86cd799439012",
    "businessCategorySlug": "beauty-salon",
    "marketingOptIn": true,
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-16T10:00:00Z"
  }
}

Common Errors​

  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions (missing businesses.manage permission)
  • 404 Not Found: Workspace not found
  • 400 Bad Request: Invalid workspace ID format
  • 500 Internal Server Error: Server error