Skip to main content

List Storefront Domains (v1)

Method & Path​

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

Description​

Retrieve all custom domains (primary + subdomains) configured 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​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Response 200 OK​

{
  "domains": [
    {
      "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"
    },
    {
      "id": "507f1f77bcf86cd799439013",
      "workspaceId": "507f1f77bcf86cd799439012",
      "domain": "shop.example.com",
      "status": "pending",
      "verificationToken": null,
      "sslStatus": "pending",
      "createdAt": "2024-12-02T10:00:00.000Z",
      "updatedAt": "2024-12-02T10:00:00.000Z"
    }
  ]
}

Response Fields​

See Get Storefront Domain for field descriptions.

Common Errors​

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have store.manage permission

404 Not Found: Workspace not found

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