Departamentos

Departamentos são as áreas da organização, por exemplo Comercial ou Financeiro. Corresponde à tela Departamentos do módulo Administrativo. Cada departamento pode indicar um gestor, que é um usuário do cliente. Os usuários são vinculados a um departamento pelo cadastro de Usuários.

Endpoints

Método	Caminho	Descrição
GET	/administrative/departments	Lista os departamentos
POST	/administrative/departments	Cadastra um departamento
GET	/administrative/departments/managers	Lista de apoio: usuários para escolher o gestor
PUT	/administrative/departments/{uuid}	Altera um departamento
DELETE	/administrative/departments/{uuid}	Apaga um departamento

GET /administrative/departments

Lista os departamentos do cliente, em ordem alfabética pelo nome, salvo se columnName e orderData forem informados.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre que busca no nome do departamento
department	Trecho do nome do departamento
columnName	Coluna para ordenar
orderData	Sentido da ordenação: asc ou desc
per_page	Quantidade de registros por página
page	Número da página, quando per_page é informado

Resposta (200): lista de departamentos, direta ou paginada. Campos principais: uuid, department, code, manager_id, manager (usuário gestor, quando houver) e user_update_name (nome de quem alterou por último).

Exemplo:

curl https://api.pedagogo.app/administrative/departments \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /administrative/departments

Cadastra um departamento. O sistema gera o uuid e registra o usuário que criou o cadastro.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
department	Sim	Texto	Nome do departamento
code	Não	Texto	Código interno do departamento
manager_id	Não	Número inteiro	id do usuário gestor. Deve existir no cadastro de usuários. A lista para escolher o gestor está em Listas de apoio, nesta página

Resposta (201): o departamento criado, com o uuid.

Exemplo:

curl -X POST https://api.pedagogo.app/administrative/departments \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{"department": "Departamento exemplo", "code": "DEP-01"}'

PUT /administrative/departments/{uuid}

Altera um departamento. Envie o corpo completo com os campos da tabela abaixo.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
department	Sim	Texto	Nome do departamento
code	Não	Texto	Código interno do departamento
manager_id	Não	Número inteiro	id do usuário gestor. Deve existir no cadastro de usuários

Resposta (200): o departamento alterado.

DELETE /administrative/departments/{uuid}

Apaga o departamento. A exclusão é lógica: o registro deixa de aparecer nas listagens, mas não é removido do banco.

Resposta (200): sem conteúdo relevante (null).

Listas de apoio

GET /administrative/departments/managers

Lista de usuários do cliente para escolher o gestor de um departamento. Aceita os mesmos parâmetros e devolve a mesma resposta de GET /administrative/users, descritos na página Usuários.