api categories Page History

Categories - API

Busca categorias

Retorna uma lista com todas as categorias

Está requisição utiliza os parâmetros de paginação page e per_page para restringir a lista.

Parâmetros:

  • include_parent (opcional) - Mostra ou não os pais da categoria('true'/'false'). Padrão 'true'.
  • include_children (opcional) - Mostra ou não os filhos da categoria('true'/'false'). Padrão 'true'.
GET /categories

{
  "categories": [
    {
      "name": "Formação",
      "id": 2,
      "slug": "formacao",
      "full_name": "Temáticas/Formação",
      "parent": {
        "name": "Temáticas",
        "id": 1,
        "slug": "tematicas"
      },
      "children": [],
      "image": null,
      "display_color": null
    },
    {
      "name": "Produção, comercialização e consumo",
      "id": 3,
      "slug": "producao-comercializacao-e-consumo",
      "full_name": "Temáticas/Produção, comercialização e consumo",
      "parent": {
        "name": "Temáticas",
        "id": 1,
        "slug": "tematicas"
      },
      "children": [],
      "image": null,
      "display_color": null
    },
  ]
}

Busca uma única categoria

Retorna uma única categoria.

Parâmetros:

  • id (obrigatório) - Id referente a categoria a ser buscada.
GET /categories/:id

{
  "category": {
    "name": "Formação",
    "id": 2,
    "slug": "formacao",
    "full_name": "Temáticas/Formação",
    "parent": {
      "name": "Temáticas",
      "id": 1,
      "slug": "tematicas"
    },
    "children": [],
    "image": null,
    "display_color": null
  }
}
Last edited by Gust