Colaboradores

Colaboradores são os funcionários e as pessoas da equipe da empresa de treinamento: dados pessoais, contato, endereço, função, data de admissão e, quando for o caso, o usuário do sistema vinculado. Também é aqui que se marca quem é inspetor, supervisor ou instrutor. Corresponde à tela Colaboradores (módulo Administrativo), disponível no pacote Premium.

Identificadores

Um colaborador tem dois identificadores uuid:

• O uuid do próprio colaborador, retornado na criação e na consulta, usado em /administrative/employees/{uuid}, nos arquivos e nas especializações.
• O uuid do cadastro da pessoa (customer_vendor.uuid na consulta do colaborador), usado nos caminhos de contatos e endereços.

Endpoints

Método	Caminho	Descrição
GET	/administrative/employees	Lista os colaboradores
POST	/administrative/employees	Cadastra um colaborador
GET	/administrative/employees/{uuid}	Consulta um colaborador
PUT	/administrative/employees/{uuid}	Altera um colaborador
DELETE	/administrative/employees/{uuid}	Remove um colaborador da lista

Os recursos de cada aba têm página própria:

Aba da tela	Página
Arquivos	Arquivos
Especialização	Especialização
Endereço	Endereços
Contatos	Contatos

Para autenticação, formato de respostas, paginação e erros, veja Autenticação e Convenções.

Regras

• CPF repetido. Se o CPF já existe no mesmo cliente, como aluno, empresa ou instrutor, o cadastro dessa pessoa é reaproveitado e atualizado, e não é criado outro. Se o colaborador foi removido antes, cadastrar de novo com o mesmo CPF o restaura.
• E-mail repetido. Se o e-mail já pertence a outra pessoa do mesmo cliente, ele não é gravado e a resposta não traz aviso.
• Exclusão. A exclusão marca a pessoa como não colaboradora e remove o registro da lista de colaboradores. O cadastro da pessoa continua nas outras telas em que aparece. Como o registro é o mesmo do instrutor, excluir um colaborador que também é instrutor o remove da lista de instrutores.

Listar, consultar, cadastrar, alterar e apagar

GET /administrative/employees

Lista os colaboradores do cliente. Sem per_page, a resposta é a lista direta; com per_page, a resposta é paginada.

Parâmetros de URL

Parâmetro	Descrição
search	Busca por nome, razão social, CPF e nome ou nome curto de curso ligado à pessoa
columnName e orderData	Ordenação: coluna e direção
per_page e page	Paginação

Resposta: 200, lista de colaboradores com uuid, name, company_name, document, birth_date, phonenumber, cellphone, email, url, observation, role (função), admission_date (data de admissão), supervisor, inspector, instructor, user_id, o endereço resumido, a chave da foto (photo_key) e os nomes de quem criou e alterou o registro.

curl "https://api.pedagogo.app/administrative/employees?search=Colaborador%20exemplo&per_page=15" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /administrative/employees

Cadastra um colaborador. Os campos de endereço são gravados no endereço do cadastro da pessoa.

Corpo

Campo	Obrigatório	Tipo	Descrição
name	Sim	Texto	Nome do colaborador
document	Sim	Texto	CPF válido, no formato 000.000.000-00. CNPJ válido também é aceito, no formato 00.000.000/0000-00
user_id	Condicional	Inteiro	Id do usuário do sistema. Obrigatório quando supervisor ou inspector for true
supervisor	Não	Booleano	Marca o colaborador como supervisor
inspector	Não	Booleano	Marca o colaborador como inspetor
instructor	Não	Booleano	Marca o colaborador como instrutor. Ele passa a aparecer na lista de instrutores
birth_date	Não	Data (AAAA-MM-DD)	Data de nascimento
role	Não	Texto	Função ou cargo
admission_date	Não	Data (AAAA-MM-DD)	Data de admissão
phonenumber	Não	Texto	Telefone
cellphone	Não	Texto	Celular
email	Não	Texto	E-mail
observation	Não	Texto	Observação
zip_code	Não	Texto	CEP
street	Não	Texto	Endereço (rua)
number	Não	Texto	Número
complement	Não	Texto	Complemento
neighborhood	Não	Texto	Bairro
city	Não	Texto	Cidade
state	Não	Texto	Estado

Resposta: 201, com o colaborador criado. Se o CPF já existia no cliente, o cadastro existente é atualizado e devolvido.

curl -X POST https://api.pedagogo.app/administrative/employees \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"name": "Colaborador exemplo", "document": "<cpf-formatado>", "role": "Coordenador"}'

GET /administrative/employees/{uuid}

Consulta um colaborador. A resposta traz o cadastro da pessoa (em customer_vendor), com a foto e a assinatura quando houver.

Resposta: 200.

PUT /administrative/employees/{uuid}

Altera um colaborador. Envie somente os campos que mudam. Nenhum campo é obrigatório nesta chamada, mas as regras de user_id, supervisor e inspector valem quando informados. Os campos aceitos são os da criação.

Se o document enviado já existir em outro cadastro do mesmo cliente, a alteração não é feita e a resposta traz a chave error com a mensagem Documento já cadastrado..

Resposta: 200, com o colaborador alterado.

DELETE /administrative/employees/{uuid}

Remove o colaborador da lista, conforme as regras desta página.

Resposta: 200.