Skip to main content
GET
/
api
/
v1
/
categories
Lista categorias com contadores de serviços e scores de popularidade
curl --request GET \
  --url https://services.pref.rio/app-busca-search/api/v1/categories \
  --header 'Authorization: Bearer <token>'
{
  "categories": [
    {
      "count": 123,
      "name": "<string>",
      "popularity_score": 123
    }
  ],
  "filtered_category": {
    "name": "<string>",
    "page": 123,
    "per_page": 123,
    "services": [
      {
        "category": "<string>",
        "created_at": 123,
        "description": "<string>",
        "id": "<string>",
        "metadata": {},
        "slug": "<string>",
        "status": 123,
        "subcategory": "<string>",
        "title": "<string>",
        "updated_at": 123
      }
    ],
    "total_services": 123
  },
  "metadata": {},
  "total_categories": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort_by
enum<string>
default:popularity

Critério de ordenação

Available options:
popularity,
count,
alpha
order
enum<string>
default:desc

Direção da ordenação

Available options:
asc,
desc
include_empty
boolean
default:false

Incluir categorias sem serviços publicados

include_inactive
boolean
default:false

Incluir serviços inativos/rascunhos (status != 1) nas contagens e filtros

filter_category
string

Nome da categoria para filtrar serviços (ex: Educação, Saúde, Transporte)

page
integer
default:1

Número da página para serviços filtrados (mínimo: 1)

Required range: x >= 1
per_page
integer
default:10

Quantidade de serviços por página (máximo: 100)

Required range: 1 <= x <= 100

Response

Lista de categorias com metadados. Se filter_category fornecido, inclui também os serviços filtrados

categories
object[]
filtered_category
object
metadata
object
total_categories
integer