Get Storefront Domain (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/storefront/domain

Description

Retrieve the primary custom domain configuration for a workspace storefront.

Authentication

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with store.manage permission.

Headers

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

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier

Response 200 OK

{
  "domain": {
    "id": "507f1f77bcf86cd799439011",
    "workspaceId": "507f1f77bcf86cd799439012",
    "domain": "example.com",
    "status": "active",
    "verificationToken": "google-site-verification=abc123",
    "sslStatus": "active",
    "createdAt": "2024-12-01T10:00:00.000Z",
    "updatedAt": "2024-12-01T10:00:00.000Z"
  }
}

Response Fields

• id (string): Domain identifier
• workspaceId (string): Workspace identifier
• domain (string): Domain name
• status (string): Domain status (pending, verified, active, disabled)
• verificationToken (string | null): Google Search Console verification token
• sslStatus (string | null): SSL certificate status (pending, active, failed)
• createdAt (string): Creation timestamp (ISO 8601 format)
• updatedAt (string): Last update timestamp (ISO 8601 format)

Common Errors

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have store.manage permission

404 Not Found: Workspace or domain not found

500 Internal Server Error: Server error occurred while processing the request