Listar Pronomes de Tratamento

Retorna uma lista de pronomes de tratamento do sistema

Este endpoint é do tipo: Protected

Descrição

Retorna uma lista de pronomes de tratamento com as seguintes funcionalidades:

Lista todos os pronomes de tratamento cadastrados no sistema
Inclui nome completo e abreviação de cada pronome
Filtros por status ativo/inativo
Busca por nome ou abreviaçã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.hmg.nabrasil.org.br/v1

ENDPOINT

/treatment-pronouns

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
active	boolean	Não	Filtrar por status ativo (true/false)
search	string	Não	Buscar por nome ou abreviaçã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": "Senhor",
      "abbreviation": "Sr.",
      "active": true,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    },
    {
      "id": 2,
      "name": "Senhora",
      "abbreviation": "Sra.",
      "active": true,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 12,
    "total": 25,
    "last_page": 3,
    "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 pronomes de tratamento retornada com sucesso
401	Token inválido ou expirado

Nunciatura Provista