Nombre del servicio
GET https://api.envialosimple.email/api/v1/folders
Método de autenticación
Authorization: Bearer
Para más detalle de cómo generar la clave API ver: Cómo enviar emails desde la API
Descripción
Devuelve una lista de todas las carpetas de archivos del gestor.
Parámetros
| Nombre | Tipo | Descripción |
| limit | Integer | Cantidad de registros por página. Por defecto: 10. Máximo: 100. |
| page | Integer | Número de página. Por defecto: 1. |
| sort | String |
Ordenar por. Valores posibles: name ➔ Nombre. |
| direction | String |
Tipo de ordenamiento. Valores posibles: asc ➔ Ascendente. desc ➔ Descendente. Por defecto: Ascendente. |
| filters | String |
Expresión para filtrar los registros. Ver detalle de la Generación de expresiones (*). Ejemplos: {"id":"65788b8f4a1c0010b000076c"} ➔ Filtra por un 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 | El tipo de ordenamiento es incorrecto. Verifique los posibles valores. |
| invalid_page | El número de página ingresado es incorrecto. Debe ser un número entero positivo. |
| invalid_limit |
La cantidad de registros por página es incorrecta. Debe ser un número entero positivo. |
| malformed_filter | La expresión para filtrar los registros ingresada es incorrecta. Ver detalle de la Generación de expresiones (*). |
Ejemplo de respuesta
{
"total": 5,
"limit": 2,
"payload": [
{
"id": "65788b8f4a1c0000b000076c",
"name": "Productos"
},
{
"id": "65805d337529c705a5266ce0",
"name": "Logos"
}
],
"page": 1
}
Comentarios
0 comentarios
El artículo está cerrado para comentarios.