Skip to main content
GET
List categories

📌 Endpoint

GET /stores/{storeId}/categories Returns all categories of a store. Categories are returned in position order (ascending), ideal for building menus/listings in the frontend.

🔐 Authentication

  • Public route for queries.
  • The store linked to storeId must have an active plan.

🧾 Route parameters


✅ Request example


🔎 Query params


🔄 Cursor pagination

For large lists (more than ~100 items), prefer cursor pagination instead of page:
  1. Make the first call without cursor.
  2. If hasMore is true, the response includes the nextCursor field.
  3. Send that nextCursor in the cursor parameter of the next request to fetch the next page.
In cursor mode, pagination is returned only with nextCursor, hasMore and limit:
  • cursor and page cannot be used together (400 INVALID_PAGINATION).
  • When there are no categories, offset mode (without cursor) returns 404 CATEGORIES_NOT_FOUND, whereas cursor mode returns 200 with categories: [], nextCursor: null, and hasMore: false.
  • nextCursor: null with hasMore: false indicate the end of the list (the API responds 200 with an empty array).

📦 Success response (200)

The first call (without cursor) already returns nextCursor and hasMore in the pagination, allowing cursor pagination to start without extra calls.

⚠️ Possible errors

  • 400 INVALID_DATA → invalid parameter
  • 400 INVALID_PAGINATION_LIMIT → limit outside the allowed range (1 to 100)
  • 400 INVALID_PAGINATION_PAGE → invalid page
  • 400 INVALID_PAGINATION_CURSOR → invalid or malformed cursor
  • 400 INVALID_PAGINATION → page and cursor used together
  • 401 UNAUTHENTICATED → could not identify the subscription user
  • 403 NO_ACTIVE_SUBSCRIPTION → inactive or expired plan
  • 404 STORE_NOT_FOUND → store not found
  • 404 CATEGORIES_NOT_FOUND → no categories found (returned only in offset mode when total is 0; cursor mode returns 200 with [])
  • 429 RATE_LIMIT_EXCEEDED → rate limit per minute exceeded
  • 500 INTERNAL_SERVER_ERROR → internal server error
  • 503 SERVICE_UNAVAILABLE → service or database unavailable

Path Parameters

storeId
string
required
Required string length: 1 - 50

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

Opaque cursor from previous page (do not combine with page).

Response

List categories.

code
string
required
Example:

"CATEGORIES_FETCHED"

categories
object[]
required
pagination
object
required