Skip to main content
GET
/
api
/
public
/
products
/
my

List My Products

Returns all products that the authenticated customer has purchased or has active. Used on the customer’s account page to show active memberships, passes, and add-on products.

Authentication

Requires a valid customer bearer token.

Query Parameters

_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=Records.Product.Name,Records.Price,Records.Quantity.

Response

Returns an array of CoworkerProduct objects with the following fields.

CoworkerProduct Fields

Identity

FieldTypeDescription
IdnumberUnique numeric identifier
UniqueIdstringGlobally unique identifier

Pricing

FieldTypeDescription
PricenumberCalculated price (including tax display)
PriceFormattedstringPrice formatted with currency symbol

Billing

FieldTypeDescription
RegularChargebooleanWhether this is a recurring charge
RepeatCyclestringBilling cycle (e.g. Monthly, Annually)
RepeatUnitnumber | nullNumber of cycles between charges
QuantitynumberQuantity purchased
InvoiceOnstring | nullNext invoice date

Product Details

FieldTypeDescription
ProductobjectNested product object (see Product Fields below)

Nested Product Fields

FieldTypeDescription
IdnumberProduct identifier
NamestringProduct display name
DescriptionstringProduct description
PricenumberUnit price (with tax display)
PriceFormattedstringPrice formatted with currency symbol
TagsstringComma-separated product tags
VisiblebooleanWhether the product is visible in the store
DisplayOrdernumberSort order in listings
CurrentStocknumber | nullCurrent stock level (if tracked)
TrackStockbooleanWhether stock tracking is enabled
AllowNegativeStockbooleanWhether negative stock is permitted
ProductCurrencyCodestringISO 4217 currency code
SystemProductTypenumberInternal product type identifier
BusinessIdnumberLocation identifier
BusinessNamestringLocation display name
BusinessWebAddressstringLocation subdomain

Timestamps (from base)

FieldTypeDescription
CreatedOnstringDate created (business-local time)
UpdatedOnstring | nullDate last updated (business-local time)
CreatedOnUtcstringDate created (UTC)
UpdatedOnUtcstring | nullDate last updated (UTC)

Examples

Fetch my products

GET /api/public/products/my
Authorization: Bearer {token}

TypeScript Integration

import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.products.my)