Ir al contenido principal

EnvíaloSimple Transaccional — API: Listar carpetas

L
Escrito por Luciana Parente

Endpoint


Autenticación

Authorization: Bearer <clave API>


Descripción

Devuelve una lista de todas las carpetas del gestor de archivos.


Parámetros

Nombre

Tipo

Descripción

limit

Integer

Registros por página. Por defecto: 10. Máximo: 100.

page

Integer

Número de página. Por defecto: 1.

sort

String

Ordenar por: name.

direction

String

Ordenamiento: asc (ascendente), desc (descendente). Por defecto: asc.

filters

String

Expresión para filtrar registros. Ejemplos: {"id":"65788b8f4a1c0010b000076c"} filtra por ID de carpeta; {"name":{"$regex":"prueba"}} filtra por nombre que contenga "prueba".


Respuesta

Campo

Descripción

id

ID de carpeta

name

Nombre de carpeta


Errores

Error

Descripción

invalid_direction

Tipo de ordenamiento incorrecto

invalid_page

Número de página incorrecto — debe ser entero positivo

invalid_limit

Cantidad de registros incorrecta — debe ser entero positivo

malformed_filter

Expresión de filtro incorrecta


Ejemplo de respuesta

{
"total": 5,
"limit": 2,
"page": 1,
"payload": [
{
"id": "65788b8f4a1c0000b000076c",
"name": "Productos"
},
{
"id": "65805d337529c705a5266ce0",
"name": "Logos"
}
]
}
¿Ha quedado contestada tu pregunta?