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",
"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"
}
],
"servicesClosure": {
"closed": false,
"message": null,
"closedAt": null
},
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-16T10:00:00Z"
}
}

Response Fields​

FieldTypeDescription
additionalStorageMBnumberAdditional storage in MB beyond plan allocation (default: 0)
invoiceAdditionsarrayArray of custom invoice additions (non-discountable charges)
invoiceAdditions[].idstringUnique identifier for the invoice addition
invoiceAdditions[].reasonstringDescription/reason for the addition
invoiceAdditions[].quantitynumberQuantity for the addition
invoiceAdditions[].unitPricenumberUnit price in USD
invoiceAdditions[].totalnumberTotal amount (quantity × unitPrice)
invoiceAdditions[].createdAtstringISO 8601 date when addition was created
invoiceAdditions[].createdBystringAdmin ID who created the addition
plan.pricePeriodsarrayPlan pricing periods with monthly, quarterly, etc.
servicesClosureobjectWhether the client app, storefront, and related public services are closed
servicesClosure.closedbooleantrue when the workspace services are closed
servicesClosure.messagestring | nullMessage shown to the owner, staff, and public visitors while closed
servicesClosure.closedAtstring | nullISO 8601 time the workspace was closed

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