Skip to navigation

Listar Test Clocks

Lista los clocks activos del Sandbox autenticado.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Headers

X-List-FormatenumOptionalDefaults to array

Forma del cuerpo. array (por defecto) devuelve el arreglo de siempre. envelope devuelve el objeto lista (ListObject): { "object": "list", "data": [...], "has_more": true, "url": "/api/customers" }, y sin page recorre la lista por cursor.

Allowed values:

Query parameters

pageintegerOptional>=1Defaults to 1

Página a devolver, en el orden propio de la lista. La respuesta trae los encabezados link, current-page, total-pages, total-count y has-more. Para recorrer una lista larga sin saltarte ni repetir objetos, usa limit y starting_after en su lugar.

limitintegerOptional1-100Defaults to 10

Cuántos objetos devolver, de 1 a 100. Sin page, recorre la lista por cursor: del más reciente al más antiguo por fecha de creación, sin conteo total, con el encabezado has-more y un link con starting_after / ending_before. Fuera de rango responde 400 con code: invalid_limit. Con page, es el tamaño de esa página, ajustado a 1–100 sin error (si también mandas items, manda items). En /payment_methods, /customers/{customer_id}/payment_methods, /product_variants, /inventory y los movimientos de inventario, que ya tomaban limit como tamaño de página, limit solo sigue paginando por página; ahí el cursor empieza con starting_after, ending_before o X-List-Format: envelope.

starting_afterstringOptional

Cursor: el id del último objeto que recibiste. Devuelve los que vienen después (más antiguos). Los objetos creados mientras recorres la lista no corren las páginas, así que no te saltas ni repites ninguno. Debe ser un objeto de esta misma lista; si no, responde 400 con code: invalid_cursor. No se combina con ending_before ni con page (code: pagination_conflict).

ending_beforestringOptional

Cursor: el id del primer objeto que recibiste. Devuelve la página anterior (objetos más recientes), también ordenada del más reciente al más antiguo; has-more dice si hay más objetos más recientes. No se combina con starting_after ni con page.

Response headers

has-moreenumOptional

true si hay más objetos después de esta página en la dirección que recorres; false si es la última.

Allowed values:

Response

Lista de clocks
list of objects
OR
object

Errors

400
Bad Request Error