Ir al contenido

Listar categorías

GET/api/category

Devuelve la lista paginada de categorías. Usa BaseControllerHelper::index, así que admite los parámetros comunes de paginación, filtros y orden descritos en Paginación, filtros y orden.

per_pageinteger

Registros por página. Por defecto 20.

searchstring

El modelo no define columnas de búsqueda, así que este parámetro no filtra ninguna columna.

category_father_idinteger

Devuelve solo las categorías hijas directas de esa categoría.

single_fathersstring

Con el valor true, devuelve solo las categorías raíz (sin padre).

relationsstring

Relaciones a cargar. El modelo no restringe las relaciones. Ver Resumen.

count_relationsstring

Conteos de relaciones. Se admite productCategories, que añade product_categories_count.

orderstring

Orden de los resultados con el formato campo|ASC o campo|DESC. Campos permitidos: id, name, created_at, updated_at, status (campos por defecto).

No exige un permiso del módulo: CategoryPolicy::viewAny devuelve verdadero para cualquier usuario autenticado.

Ventana de terminal
curl -G \
"https://servererp.allendostmen.app/api/category" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json" \
--data-urlencode "per_page=20" \
--data-urlencode "single_fathers=true" \
--data-urlencode "count_relations=productCategories"
Lista de categorías200
{
"current_page": 1,
"data": [
{
"id": 1,
"name": "Cables",
"description": "Cables eléctricos",
"image": null,
"thumbnail": null,
"level": 1,
"category_father_id": null,
"status": "activo",
"previous_status": null,
"status_update_comment": null,
"status_update_date": null,
"status_update_user_id": null,
"create_user_id": 1,
"update_user_id": null,
"delete_user_id": null,
"restore_user_id": null,
"created_at": "2026-11-19T10:40:15.000000Z",
"updated_at": "2026-11-19T10:40:15.000000Z",
"deleted_at": null,
"product_categories_count": 12
}
],
"first_page_url": "https://servererp.allendostmen.app/api/category?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://servererp.allendostmen.app/api/category?page=1",
"next_page_url": null,
"path": "https://servererp.allendostmen.app/api/category",
"per_page": 20,
"prev_page_url": null,
"to": 1,
"total": 1
}
Sin permiso403
{
"message": "This action is unauthorized."
}