Authorization
Example:
Authorization | Bearer Paste-Your-API-Key-HereQuery Parameters
Number of items to return per page. Defaults to
10, with a maximum of 50.Cursor for forward pagination. Pass the
nextStartingAfter value from the
previous response (a Unix timestamp in milliseconds, as a string) to fetch the
next page.Filter products by name keyword.
Filter products by product type (e.g.
generic_link, event, webinar,
digital_product).Filter products by stock availability.
Response
Successful ResponseMain Structure (Root)
Status code form API.
Status message that describes the status code.
List of products displayed.
Information on whether there is additional data to be retrieved (true/false).
Cursor to pass as
startingAfter to fetch the next page. null when there is
no further data.data Structure (Array Of Object)
Unique identifier of the product.
Product price amount.
Product category if available.
Timestamp in milliseconds indicating when the product was created.
Product description in HTML format.
Unique slug or identifier used in the product URL.
Product type (e.g.,
saas, event, membership, ebook, etc.).Product subtype if applicable.
Current product status (e.g.,
active, inactive).Product name.
Purchase or access limit if configured.
URL where the customer will be redirected after checkout.
Installment identifier if the product supports installment payments.
Product variant.
Membership product tier.
Event details.
Order configuration if applicable.
Identifier of the cover image.
Identifier list of additional images.
Cover image object containing image details.
List of additional image objects.
Product variants.
Public product page URL.
Public payment link URL.
