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

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace ID

Query Parameters

None.

Request Body

None.

Response 200 OK

{
  "workspace": {
    "id": "507f1f77bcf86cd799439011",
    "name": "Example Workspace",
    "email": "workspace@example.com",
    "planId": "507f1f77bcf86cd799439012",
    "plan": {
      "id": "507f1f77bcf86cd799439012",
      "name": "Starter",
      "slug": "starter",
      "isActive": true,
      "pricePeriods": [
        {
          "period": "monthly",
          "amountCents": 5000,
          "currencyCode": "USD"
        }
      ]
    },
    "businessCategorySlug": "beauty-salon",
    "marketingOptIn": true,
    "subscriptionEndDate": "2025-12-31T23:59:59.000Z",
    "discountPercentage": 10,
    "additionalStorageMB": 1024,
    "invoiceAdditions": [
      {
        "id": "507f1f77bcf86cd799439013",
        "reason": "Additional 1GB storage",
        "quantity": 1,
        "unitPrice": 2.00,
        "total": 2.00,
        "createdAt": "2024-01-15T10:00:00.000Z",
        "createdBy": "507f1f77bcf86cd799439014"
      }
    ],
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-01-16T10:00:00Z"
  }
}

Response Fields

Field	Type	Description
additionalStorageMB	number	Additional storage in MB beyond plan allocation (default: 0)
invoiceAdditions	array	Array of custom invoice additions (non-discountable charges)
invoiceAdditions[].id	string	Unique identifier for the invoice addition
invoiceAdditions[].reason	string	Description/reason for the addition
invoiceAdditions[].quantity	number	Quantity for the addition
invoiceAdditions[].unitPrice	number	Unit price in USD
invoiceAdditions[].total	number	Total amount (quantity × unitPrice)
invoiceAdditions[].createdAt	string	ISO 8601 date when addition was created
invoiceAdditions[].createdBy	string	Admin ID who created the addition
plan.pricePeriods	array	Plan pricing periods with monthly, quarterly, etc.

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