v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Store

List Stores

List Stores

get/workspaces/{workspace_id}/stores

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Store ID

public_idstring nullable

Store Public ID

namestring

Name

current_pathstring nullable

Current path

seo_titlestring nullable

SEO title

seo_descriptionstring nullable

SEO description

seo_indexableboolean nullable

SEO Indexable

social_image_idstring nullable

Social image

status'draft' | 'published' nullable

Store Status

created_atstring nullable

Added

updated_atstring nullable

Updated

workspace_idinteger nullable

Workspace ID

Example response

[
  {
    "id": 1,
    "public_id": "hlXaqR",
    "name": "Example Store",
    "current_path": "/example-store",
    "seo_title": "Example Store",
    "seo_description": "Example Store",
    "seo_indexable": true,
    "social_image_id": null,
    "status": "draft",
    "created_at": null,
    "updated_at": null,
    "workspace_id": 42000
  }
]