Introdução

Busca

Catálogo

Subpav OSA SMS

eAi Agent

Registro Municipal Integrado

GO

Encurtador de URLs

Surkai

Heimdall API

Lista subcategorias de uma categoria específica

curl --request GET \
  --url https://services.pref.rio/app-busca-search/api/v1/categories/{category}/subcategories \
  --header 'Authorization: Bearer <token>'

{
  "category": "<string>",
  "metadata": {},
  "subcategories": [
    {
      "category": "<string>",
      "count": 123,
      "name": "<string>",
      "popularity_score": 123
    }
  ],
  "total_subcategories": 123
}

subcategories

Lista subcategorias de uma categoria específica

Retorna lista de subcategorias dentro de uma categoria pai, ordenadas por popularidade, quantidade de serviços ou ordem alfabética. Subcategorias são extraídas dinamicamente dos serviços via facet search no Typesense.

Casos de Uso:

Listar subcategorias: GET /api/v1/categories/Educação/subcategories
Ordenar por quantidade: GET /api/v1/categories/Educação/subcategories?sort_by=count&order=desc
Incluir vazias: GET /api/v1/categories/Educação/subcategories?include_empty=true

GET

api

Authorizations

Authorization

string

header

required

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

Path Parameters

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 subcategorias sem serviços publicados

include_inactive

boolean

default:false

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

Response

Lista de subcategorias com metadados