Skip to main content
GET
List my products

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

localCenter
string
localCenter[]
string[]
organisation
string
organisation[]
string[]
type
string
type[]
string[]
order[createdAt]
enum<string>
default:asc
Available options:
asc,
desc
exists[organisation]
boolean
exists[localCenter]
boolean
exists[isArchived]
boolean
exists[hasLocalCenterOption]
boolean

Response

200 - application/json

Product collection

uuid
string | null
read-only
id
integer
read-only
name
string
nameEn
string | null
productStripeId
string | null
localCenter
string<iri-reference> | null
Example:

"/api/v1/local_centers/1"

productPrices
object[]
isArchived
boolean | null
default:false
hasSubscription
boolean | null
hasOneTimePayment
boolean | null
goalValue
integer | null
createdAt
string<date-time> | null
description
string | null
descriptionEn
string | null
logo
string | null
isFee
boolean | null
read-only
isDonation
boolean | null
read-only
settings
(string | null)[] | null
descriptionInternal
string | null
type
string | null
goalValueSubscription
integer | null
abTestingEnabled
boolean | null
slug
string | null
slugGo
string | null
slugEnGo
string | null
metaGraphImage
string | null