Favicon

You are here: Home > API Reference > Workspace > Organization Store > List organization stores

List organization stores

Required Permission: mad.store.management.list

Retrieves a paginated list of stores belonging to the organization.

GET
/v1/organizations/:organizationId/stores/
Copy to clipboard

List organization stores

Required Permission: mad.store.management.list

Retrieves a paginated list of stores belonging to the organization.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Responses

200 Response application/json
status boolean optional
data object optional
items array [object] optional
id string optional
Unique identifier for the store entity within the organization context.
Match pattern: ^[a-fA-F0-9]{24}$
organization string optional
Identifier of the organization to which the store belongs.
Match pattern: ^[a-fA-F0-9]{24}$
security string optional
Security configuration type for the store, selected from predefined options.
public logged
customDomain string optional
Custom domain name assigned to the store for external access.
branding object optional
buttonColor string optional
Hexadecimal color code used for branding the store’s main button.
Match pattern: ^#[a-zA-Z0-9]{6}$
configuration object optional
allowPublicPubApps boolean optional
Indicates whether public publisher applications are allowed in the store.
createdBy string optional
Identifier of the user who created the store.
Match pattern: ^[a-fA-F0-9]{24}$
updatedAt string optional
Timestamp when the store was last updated, in ISO-8601 format.
Format: date-time
createdAt string optional
Timestamp when the store was created, in ISO-8601 format.
Format: date-time
totalDocs integer optional
limit integer optional
hasPrevPage boolean optional
hasNextPage boolean optional
page integer optional
totalPages integer optional
prevPage integer optional
nextPage integer optional
lean boolean optional
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "69a99f0796c600009c03597d",
                "organization": "69a99f0796c600009c03597d",
                "security": "public",
                "customDomain": "store.example.com",
                "branding": {
                    "buttonColor": "#007AFF"
                },
                "configuration": {
                    "allowPublicPubApps": true
                },
                "createdBy": "69a99f0796c600009c03597d",
                "updatedAt": "2026-03-05T12: 00:00Z",
                "createdAt": "2026-02-10T12: 00:00Z"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}