List public catalog CMS products

curl --request GET \
  --url https://api.simplepay.mx/v1/catalog/products \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.simplepay.mx/v1/catalog/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.simplepay.mx/v1/catalog/products"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": [
    {
      "active": true,
      "categories": [
        {
          "active": true,
          "description": "<string>",
          "fallback": {},
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "object": "<unknown>",
          "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "sortOrder": 123,
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "content": {},
      "description": "<string>",
      "fallback": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "marketingFeatures": [
        "<string>"
      ],
      "name": "<string>",
      "object": "<unknown>",
      "primaryCategory": {
        "active": true,
        "description": "<string>",
        "fallback": {},
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "object": "<unknown>",
        "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "sortOrder": 123,
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "slug": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "bundle": {
        "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "versionNumber": 2,
        "components": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "object": "<unknown>",
            "slug": "<string>",
            "name": "<string>",
            "description": "<string>",
            "fallback": {},
            "quantity": 2,
            "categories": [
              {
                "active": true,
                "description": "<string>",
                "fallback": {},
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>",
                "object": "<unknown>",
                "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "slug": "<string>",
                "sortOrder": 123,
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            ]
          }
        ]
      }
    }
  ],
  "next_cursor": "<string>",
  "object": "<unknown>"
}

GET

https://api.simplepay.mx

catalog

products

List public catalog CMS products

curl --request GET \
  --url https://api.simplepay.mx/v1/catalog/products \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.simplepay.mx/v1/catalog/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.simplepay.mx/v1/catalog/products"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": [
    {
      "active": true,
      "categories": [
        {
          "active": true,
          "description": "<string>",
          "fallback": {},
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "object": "<unknown>",
          "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "sortOrder": 123,
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "content": {},
      "description": "<string>",
      "fallback": {},
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "marketingFeatures": [
        "<string>"
      ],
      "name": "<string>",
      "object": "<unknown>",
      "primaryCategory": {
        "active": true,
        "description": "<string>",
        "fallback": {},
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "object": "<unknown>",
        "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "sortOrder": 123,
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "slug": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "bundle": {
        "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "versionNumber": 2,
        "components": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "object": "<unknown>",
            "slug": "<string>",
            "name": "<string>",
            "description": "<string>",
            "fallback": {},
            "quantity": 2,
            "categories": [
              {
                "active": true,
                "description": "<string>",
                "fallback": {},
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>",
                "object": "<unknown>",
                "parentCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "slug": "<string>",
                "sortOrder": 123,
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            ]
          }
        ]
      }
    }
  ],
  "next_cursor": "<string>",
  "object": "<unknown>"
}

Uso

Usalo para leer catalogo publico y construir experiencias de discovery sin duplicar datos de productos o categorias.

Antes de llamar

Tema	Detalle
Metodo	`GET`
Ruta	`/v1/catalog/products`
Auth	Bearer API key del ambiente correcto.
Scope	`catalog:read`
Idempotencia	No aplica para lecturas.
Guia relacionada	API Reference overview

Patron recomendado

Ejecuta esta lectura desde backend cuando incluya datos privados del tenant.
Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.

Ejemplo minimo

terminal

curl -sS "https://api.simplepay.mx/v1/catalog/products" \
  -H "Authorization: Bearer $SIMPLEPAY_API_KEY"

Errores a manejar

400 indica payload, parametros o estado invalido.
401 o 403 indican API key, ambiente o scopes incorrectos.
429 y 5xx se pueden reintentar con backoff; en writes conserva la misma idempotency key.

Contrato OpenAPI

El playground, parametros, body y respuestas de abajo salen de /openapi.json. Si el contrato cambia, actualiza la spec y regenera esta pagina.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

zh,

zh-hans

Response

200 - application/json

Public catalog CMS products

data

object[]

Hide child attributes

data.active

boolean

data.categories

object[]

Hide child attributes

data.categories.active

boolean

data.categories.description

string

data.categories.fallback

object

Hide child attributes

data.categories.fallback.{key}

enum<string> | null

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

base,

id,

null

data.categories.id

string<uuid>

data.categories.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.categories.name

string

data.categories.object

any

data.categories.parentCategoryId

string<uuid>

data.categories.slug

string

data.categories.sortOrder

integer

data.categories.updatedAt

string<date-time>

data.content

object

data.description

string

data.fallback

object

Hide child attributes

data.fallback.{key}

enum<string> | null

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

base,

id,

null

data.id

string<uuid>

data.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.marketingFeatures

string[]

data.name

string

data.object

any

data.primaryCategory

object

Hide child attributes

data.primaryCategory.active

boolean

data.primaryCategory.description

string

data.primaryCategory.fallback

object

Hide child attributes

data.primaryCategory.fallback.{key}

enum<string> | null

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

base,

id,

null

data.primaryCategory.id

string<uuid>

data.primaryCategory.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.primaryCategory.name

string

data.primaryCategory.object

any

data.primaryCategory.parentCategoryId

string<uuid>

data.primaryCategory.slug

string

data.primaryCategory.sortOrder

integer

data.primaryCategory.updatedAt

string<date-time>

data.productType

enum<string>

Available options:

appointment,

bundle,

class,

scheduled_offer,

experience,

package,

rental,

service,

standard,

date_range

data.slug

string

data.updatedAt

string<date-time>

data.bundle

object

Hide child attributes

data.bundle.versionId

string<uuid>

data.bundle.versionNumber

integer

Required range: x >= 1

data.bundle.chargeMode

enum<string>

Available options:

fixed_price,

sum_components

data.bundle.components

object[]

Hide child attributes

data.bundle.components.id

string<uuid>

data.bundle.components.object

any

data.bundle.components.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.bundle.components.slug

string

data.bundle.components.name

string

data.bundle.components.description

string

data.bundle.components.fallback

object

Hide child attributes

data.bundle.components.fallback.{key}

enum<string> | null

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

base,

id,

null

data.bundle.components.productType

enum<string>

Available options:

appointment,

bundle,

class,

scheduled_offer,

experience,

package,

rental,

service,

standard,

date_range

data.bundle.components.quantity

integer

Required range: x >= 1

data.bundle.components.categories

object[]

Hide child attributes

data.bundle.components.categories.active

boolean

data.bundle.components.categories.description

string

data.bundle.components.categories.fallback

object

Hide child attributes

data.bundle.components.categories.fallback.{key}

enum<string> | null

Available options:

es,

en,

pt,

de,

fr,

zh-Hans,

base,

id,

null

data.bundle.components.categories.id

string<uuid>

data.bundle.components.categories.locale

enum<string>

Available options:

es,

en,

pt,

de,

fr,

zh-Hans

data.bundle.components.categories.name

string

data.bundle.components.categories.object

any

data.bundle.components.categories.parentCategoryId

string<uuid>

data.bundle.components.categories.slug

string

data.bundle.components.categories.sortOrder

integer

data.bundle.components.categories.updatedAt

string<date-time>

next_cursor

string | null

object

any

Last modified on June 21, 2026

List public catalog CMS category tree Retrieve a public catalog CMS product

Overview

Checkout

Payment Links

Refunds

Payment Policy

Products

Catalog

Customer Hub

Bookable: setup

Bookable: resources

Bookable: disponibilidad

Bookable: event types

Bookable: holds y bookings

Webhooks y eventos

Meta

List public catalog CMS products

Uso

Antes de llamar

Patron recomendado

Ejemplo minimo

Errores a manejar

Contrato OpenAPI

Authorizations

Query Parameters

Response

​Uso

​Antes de llamar

​Patron recomendado

​Ejemplo minimo

​Errores a manejar

​Contrato OpenAPI

Authorizations

Query Parameters

Response

Uso

Antes de llamar

Patron recomendado

Ejemplo minimo

Errores a manejar

Contrato OpenAPI