Solicitudes
La API sigue convenciones REST. Las colecciones se exponen usando el nombre de su endpoint.
URL base
Operaciones comunes
| Operación | Método | Ruta |
|---|---|---|
| Listar documentos | GET | /{resource} |
| Obtener un documento | GET | /{resource}/{id} |
| Crear un documento | POST | /{resource} |
| Editar un documento | PATCH | /{resource}/{id} |
| Eliminar un documento | DELETE | /{resource}/{id} |
Algunos recursos solo permiten operaciones de lectura.
Parámetros de query
| Parámetro | Ejemplo | Descripción |
|---|---|---|
limit | limit=10 | Cantidad de documentos por página. |
page | page=2 | Número de página a devolver. |
sort | sort=-createdAt | Orden ascendente por campo, o descendente usando -. |
where | where[status][equals]=open | Filtra documentos por campo y operador. |
depth | depth=0 | Controla la expansión de relaciones. |