Skip to main content

Get Store (v1)

Method + Path

GET /v1/workspace/:workspaceId/storefront/store

Actual backend path: /v1/workspace/:workspaceId/storefront/store

Description

Get the storefront store configuration for a workspace.

Authentication

Required - JWT token in Authorization header

Required Permissions:

  • storefront.view or storefront.update

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier

Response (200)

{
"store": {
"id": "507f1f77bcf86cd799439011",
"workspaceId": "507f1f77bcf86cd799439012",
"name": "My Store",
"slug": "my-store",
"description": "Store description",
"logoUrl": "https://example.com/logo.jpg",
"seoOgImageUrl": "https://example.com/og-image.jpg",
"createdAt": "2024-01-15T10:00:00Z"
}
}

Common Errors

  • 401 Unauthorized: Missing or invalid authentication token
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Store or workspace not found
  • 500 Internal Server Error: Server error