Listar Funções Eclesiásticas
Retorna uma lista de funções eclesiásticas do sistema
Descrição
Retorna uma lista de funções eclesiásticas com as seguintes funcionalidades:
- Lista todas as funções eclesiásticas cadastradas no sistema
- Inclui nome e descrição de cada função
- Busca por nome ou descrição
- Paginação com 12 itens por página (padrão)
- Requer autenticação JWT válida
Detalhes do Endpoint
VERBO
GET
URL BASE
http://api.provista.dev.nabrasil.org.br/v1
ENDPOINT
/categories
Parâmetros de Query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| search | string | Não | Buscar por nome ou descrição |
| page | integer | Não | Número da página (padrão: 1) |
| per_page | integer | Não | Itens por página (padrão: 12) |
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer <token> |
| Accept | application/json |
Respostas
Sucesso - 200
{
"success": true,
"data": [
{
"id": 1,
"name": "Consultor diocesano",
"description": "Membro do conselho diocesano",
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-01T00:00:00.000000Z"
},
{
"id": 2,
"name": "Vigário Geral",
"description": "Responsável pela administração geral da diocese",
"created_at": "2024-01-01T00:00:00.000000Z",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"pagination": {
"current_page": 1,
"per_page": 12,
"total": 15,
"last_page": 2,
"from": 1,
"to": 12,
"has_more_pages": true
}
}
Nota: Este endpoint retorna dados paginados com 12 itens por página (padrão). Use os parâmetros page e per_page para navegar e customizar a paginação.
Erro - 401 (Token inválido)
{
"success": false,
"message": "Token não fornecido"
}
Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Lista de funções eclesiásticas retornada com sucesso |
| 401 | Token inválido ou expirado |