Logo Sólides
API docs by Redocly

API Solides (1.0.19)

Download OpenAPI specification:

License: Apache 2.0

Introdução

A API Sólides é RESTful, e assim podemos oferecer um conjunto de funcionalidades do nosso sistema para ter uma boa integração junto com o sistema da sua empresa.
Nossa API de integração com o sistema Solides Gestão. A mesma oferece criação, edição, atualização de registros importantes para sua empresa como:
Passaportes, Colaboradores, Ocorrências e Currículos.

  • Vantagens da Integração:

    • Automatização
    • Agilidade
    • Certeza das informações
    • Ganho de tempo
    • Monitoramento em tempo real
    • Expertise em integrações nível LATAM
    • Redução de tempo da sua equipe de TI

  • O que integramos:

    • Ficha do Colaborador
    • Cargos
    • Departamentos
    • Atualizações cadastrais
    • Ficha do Colaborador

  • Base URL:

    • https://app.solides.com/pt-BR/api/v1/
    • AVD V3
      • https://apigw.solides.com.br/management/

Autenticação

Em nossas requisições é obrigatório informar na URL base o parâmetro {locale} cujo os valores possvíeis são: pt-BR, ou es, ou en". E todas devem ser autenticadas, esta autenticação é realizada a partir de um token, gerado a partir de nossa plataforma. O token deve ser enviado no cabeçalho (header) da requisição HTTPS.

  • Para gerar o token de acesso siga os seguintes passos:
    • Acesse https://app.solides.com/pt-BR/usuarios/sign_in e logue com seu usuário
    • Acesse o sub-menu Configurações
    • Na seção Ativar API de Integração, clique em Ativar API. Isso gerará um token único que deverá ser utilizado em todas as requisições.
    • Configure a Header de sua requisição com essas três variáveis, onde Authorization receberá o token de sua base único e intransferível:
      • Authorization: Token token= SEU_TOKEN
      • Accept: application/json
      • Content-Type: application/json
    • Após a configuração, o Header estará semelhante ao exemplo abaixo: 
      Authorization: Token token=pca3e478144a2bf2a05c1fb1fe98asdk53247secfb55c1709e669
Accept: application/json 
Content-Type: application/json

Ocorrências

Ocorrências para os colaboradores da empresa

Busca por todas ocorrências

Listar todas as ocorrências da empresa

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registra uma nova ocorrência

Registra uma nova ocorrência

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar uma nova ocorrência.

idNumber
string

Número de cpf do colaborador sem formatação

incidentDate
string <date>

data da ocorrência

classification
string

classificação para a ocorrência

comment
string

comentário da ocorreência

value
number <float>

valor da ocorrência

typeIncidentId
integer

Idenficador do tipo de ocorrência. ["1 - Falta/Ausência", "2 - Atraso", "3 - Promoção", "4 - Falha/Erro", "5 - Ideia / Contribuição", "6 - Recontratação", "7 - Outros", "8 - Advertência", "9 - Suspensão", "10 - Feedback", "11 - Subperformance", "12 - Folga"]

Responses

Request samples

Content type
application/json
{
  • "idNumber": "123456789101",
  • "incidentDate": "12/07/2017",
  • "classification": "Positivo",
  • "comment": "Comentário para Fulano",
  • "value": "12,90",
  • "typeIncidentId": 1
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "incidentDate": "12/07/2017",
  • "classification": "Positivo",
  • "comment": "Comentário para Fulano",
  • "value": "12,90",
  • "typeIncident": "Atraso",
  • "colaborador": {
    }
}

Busca por uma ocorrência

Busca ocorrência pelo id

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único da ocorrência

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "incidentDate": "12/07/2017",
  • "classification": "Positivo",
  • "comment": "Comentário para Fulano",
  • "value": "12,90",
  • "typeIncident": "Atraso",
  • "colaborador": {
    }
}

Deleta uma ocorrência

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único da ocorrência

Responses

Colaboradores

Colaboradores de sua empresa

Busca por todos colaboradores

Listar todos colaboradores da empresa

Authorizations:
apiToken
query Parameters
status
string
Example: status=todos

Aumenta escopo da busca para incluir inativos.

page_size
string
Example: page_size=150

Quando informado junto ao parâmetro 'page' irá definir a quantidade de registros por página.

page
integer
Example: page=1

Quando informado junto ao parâmetro 'page_size' irá definir qual página deve ser retornada.

data_admissao
string
Example: data_admissao=01/01/2022

Recuperar registros de pessoas admitidas a partir da data especificada.

data_admissao_anterior
string
Example: data_admissao_anterior=01/01/2023

Recuperar registros de pessoas admitidas antes da data especificada.

header Parameters
Authentication
required
string

token_api da empresa

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registra um novo colaborador

Registra um novo colaborador

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar um colaborador.

name
required
string

nome do colaborador

email
required
string

email do colaborador

birthDate
string <date>

data de nascimento

gender
string
Enum: "Feminino" "Masculino"

sexo do colaborador

maritalStatus
string
Enum: "Casado" "Solteiro" "União Estável" "Divorciado" "Viúvo" "Separado"

estado civil do colaborador

education
string
Enum: "Curso extra-curricular" "Fundamental Incompleto" "Fundamental Completo" "Médio Incompleto" "Médio Completo" "Superior Incompleto" "Superior Completo" "Pós Graduação" "Mestrado" "Doutorado"

escolaridade do colaborador

nationality
string

nacionalidade do colaborador

birthPlace
string

naturalidade do colaborador

fatherName
string

nome do pai

motherName
string

nome da mae

zipCode
string

cep do colaborador

countryAcronym
string

país do colaborador (Sigla)

stateAcronym
string

estado do colaborador (Sigla)

city
string

cidade do colaborador

neighborhood
string

bairro do colaborador

streetName
string

Rua do colaborador

number
string

número de endereço

additionalInformation
string

complemento do endereco

phone
string

telefone fixo

cellPhone
string

telefone celular

emergencyPhoneNumber
string

número de emergência

personalEmail
string

email pessoal

corporateEmail
string

email coorporativo

departamentId
integer <int64>

identificador do departamento

positionId
integer <int64>

identificador do cargo

unityId
integer <int64>

identificador da unidade

typeContract
string
Enum: "CLT" "CLT + Comissão" "Comissionado" "Concursados" "Contrato" "Cooperado" "Efetivos" "Estagiário" "Estatuários" "Menor Aprendiz" "Jovem aprendiz" "Outros" "Parceiros" "Prestador de Serviço" "Sócio" "Temporário" "Mais Médicos" "Cedido pela União"

tipo de contrato

dateContract
string

data de início do contrato

contractDuration
string

tempo de duração do contrato

contractExpirationDate
string <date>

data final do contrato

registration
string

matrícula do colaborador

senior
integer <int64>

identificador da pessoa superior direta.

salary
number <float> <= 99999999.99

salário do colaborador

workShift
string

turno do colaborador

hierarchicalLevel
string
Enum: "Alto" "Baixo" "Médio"

nível hierárquico do colaborador

dateAdmission
string <date>

data de admissão do colaborador

dateDismissal
string <date>

data de demissão do colaborador

idNumber
string

cpf do colaboraor

rg
string

rg do colaborador

data_expedicao
string

data de expedição do rg

orgao_expedidor
string

orgão emissor do rg

cpf
required
string

CPF do colaborador

voterRegistration
string

título de eleitor do colaborador

electoralZone
string

zona eleitoral do colaborador

electoralSection
string

seção eleitoral do colaborador

ctpsNum
string

ctps num do colaborador

ctpsSerie
string

ctps serie do colaborador

reservist
string

número de reservista do colaborador

nqc
string

cnh do colaborador

bank
string

nome do banco do colaborador

agency
string

número da agência do colaborador

checkingsAccount
string

conta corrente do colaborador

pis
string

pis do colaborador

disabledPerson
boolean

Portador de Necessidade

typeOfSpecialNeed
string

Tipo de necessidade especial

ethnicity
string
Enum: "Branca" "Preta" "Amarela" "Parda" "Indígena" "Outro"

Etnia

salutation
string
Enum: "Prezado Sr." "Prezada Sra." "Prezado" "Prezada" "Amigo" "Amiga" "Caro" "Cara" "Querida" "Querido"

Saudação

Responses

Request samples

Content type
application/json
{
  • "name": "Nome X",
  • "email": "email@example.com.br",
  • "birthDate": "01/01/1991",
  • "gender": "Feminino",
  • "maritalStatus": "Solteiro",
  • "education": "Doutorado",
  • "nationality": "Brasileiro",
  • "birthPlace": "Belo Horizontino",
  • "fatherName": "Nome X",
  • "motherName": "Nome Y",
  • "zipCode": "00.000-000",
  • "countryAcronym": "BR",
  • "stateAcronym": "MG",
  • "city": "Belo Horizonte",
  • "neighborhood": "Savassi",
  • "streetName": "Rua Sobradinho",
  • "number": "1",
  • "additionalInformation": "Apto 1",
  • "phone": "(31) 33333333",
  • "cellPhone": "(31) 999999999",
  • "emergencyPhoneNumber": "(31) 999999999",
  • "personalEmail": "email@gmail.com",
  • "corporateEmail": "email@example.com.br",
  • "departamentId": 1,
  • "positionId": 1,
  • "unityId": 1,
  • "typeContract": "CLT",
  • "dateContract": "01/01/2018",
  • "contractDuration": "12 meses",
  • "contractExpirationDate": "12/09/2019",
  • "registration": "3819",
  • "senior": 1,
  • "salary": 3798.9,
  • "workShift": "Diurno",
  • "hierarchicalLevel": "Alto",
  • "dateAdmission": "01/01/2018",
  • "dateDismissal": "01/01/2018",
  • "idNumber": "22426759666",
  • "rg": "390569422",
  • "data_expedicao": "02/01/2019",
  • "orgao_expedidor": "SSP",
  • "cpf": "01234567890",
  • "voterRegistration": "282850080221",
  • "electoralZone": "131",
  • "electoralSection": "Seção 29",
  • "ctpsNum": "22426759",
  • "ctpsSerie": "2242",
  • "reservist": "39330569422",
  • "nqc": "29998619616",
  • "bank": "Bradesco",
  • "agency": "2202",
  • "checkingsAccount": "0186958-2",
  • "pis": "48348426997",
  • "disabledPerson": true,
  • "typeOfSpecialNeed": "Visual",
  • "ethnicity": "Outro",
  • "salutation": "Prezado Sr."
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Maria de Fátima Souza",
  • "idNumber": "11223344556",
  • "email": "email@example.com.br",
  • "birthDate": "01/01/1987",
  • "education": "medio_completo",
  • "course": "Arquiteura e Urbanismo",
  • "registration": "381998",
  • "gender": "Feminino",
  • "dateAdmission": "01/01/2018",
  • "dateDismissal": "02/01/2019",
  • "reasonDismissal": "Motivo da demissão",
  • "ethnicity": "Outro",
  • "workShift": "Diurno",
  • "typeContract": "CLT",
  • "senior": {
    },
  • "active": true,
  • "updated_at"": "02/01/2019",
  • "departament": {
    },
  • "position": {
    },
  • "vinculo_externos": [
    ],
  • "unity": {
    }
}

Busca por um colaborador

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do colaborador

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Maria de Fátima Souza",
  • "email": "email@example.com.br",
  • "registration": "381998",
  • "birthDate": "01/01/1987",
  • "gender": "Feminino",
  • "maritalStatus": "Solteiro",
  • "salutation": "Prezado Sr.",
  • "nationality": "Brasileiro",
  • "birthplace": "Belo Horizontino",
  • "education": "Superior Completo",
  • "course": "Arquiteura e Urbanismo",
  • "dateAdmission": "01/01/2018",
  • "salary": "R$ 3.890,00",
  • "dateDismissal": "02/01/2019",
  • "reasonDismissal": "Motivo da demissão",
  • "hierarchicalLevel": "Alto",
  • "typeContract": "CLT",
  • "dateContract": "01/01/2018",
  • "durationContract": "12 meses",
  • "contractExpirationDate": "01/01/2019",
  • "workShift": "Diurno",
  • "ethnicity": "Outro",
  • "position": {
    },
  • "departament": {
    },
  • "contact": {
    },
  • "documents": {
    },
  • "dependents": [
    ],
  • "vacations": [
    ],
  • "benefits": [
    ],
  • "healthAndSafety": [
    ],
  • "vinculo_externos": [
    ],
  • "unity": {
    }
}

Atualiza informações de um colaborador

Atualiza informações de um colaborador

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do colaborador

Request Body schema: application/json
required

Parâmetros para registrar um colaborador.

name
required
string

nome do colaborador

email
required
string

email do colaborador

birthDate
string <date>

data de nascimento

gender
string
Enum: "Feminino" "Masculino"

sexo do colaborador

maritalStatus
string
Enum: "Casado" "Solteiro" "União Estável" "Divorciado" "Viúvo" "Separado"

estado civil do colaborador

education
string
Enum: "Curso extra-curricular" "Fundamental Incompleto" "Fundamental Completo" "Médio Incompleto" "Médio Completo" "Superior Incompleto" "Superior Completo" "Pós Graduação" "Mestrado" "Doutorado"

escolaridade do colaborador

nationality
string

nacionalidade do colaborador

birthPlace
string

naturalidade do colaborador

fatherName
string

nome do pai

motherName
string

nome da mae

zipCode
string

cep do colaborador

countryAcronym
string

país do colaborador (Sigla)

stateAcronym
string

estado do colaborador (Sigla)

city
string

cidade do colaborador

neighborhood
string

bairro do colaborador

streetName
string

Rua do colaborador

number
string

número de endereço

additionalInformation
string

complemento do endereco

phone
string

telefone fixo

cellPhone
string

telefone celular

emergencyPhoneNumber
string

número de emergência

personalEmail
string

email pessoal

corporateEmail
string

email coorporativo

departamentId
integer <int64>

identificador do departamento

positionId
integer <int64>

identificador do cargo

unityId
integer <int64>

identificador da unidade

typeContract
string
Enum: "CLT" "CLT + Comissão" "Comissionado" "Concursados" "Contrato" "Cooperado" "Efetivos" "Estagiário" "Estatuários" "Menor Aprendiz" "Jovem aprendiz" "Outros" "Parceiros" "Prestador de Serviço" "Sócio" "Temporário" "Mais Médicos" "Cedido pela União"

tipo de contrato

dateContract
string

data de início do contrato

contractDuration
string

tempo de duração do contrato

contractExpirationDate
string <date>

data final do contrato

registration
string

matrícula do colaborador

senior
integer <int64>

identificador da pessoa superior direta.

salary
number <float> <= 99999999.99

salário do colaborador

workShift
string

turno do colaborador

hierarchicalLevel
string
Enum: "Alto" "Baixo" "Médio"

nível hierárquico do colaborador

dateAdmission
string <date>

data de admissão do colaborador

dateDismissal
string <date>

data de demissão do colaborador

idNumber
string

cpf do colaboraor

rg
string

rg do colaborador

data_expedicao
string

data de expedição do rg

orgao_expedidor
string

orgão emissor do rg

cpf
required
string

CPF do colaborador

voterRegistration
string

título de eleitor do colaborador

electoralZone
string

zona eleitoral do colaborador

electoralSection
string

seção eleitoral do colaborador

ctpsNum
string

ctps num do colaborador

ctpsSerie
string

ctps serie do colaborador

reservist
string

número de reservista do colaborador

nqc
string

cnh do colaborador

bank
string

nome do banco do colaborador

agency
string

número da agência do colaborador

checkingsAccount
string

conta corrente do colaborador

pis
string

pis do colaborador

disabledPerson
boolean

Portador de Necessidade

typeOfSpecialNeed
string

Tipo de necessidade especial

ethnicity
string
Enum: "Branca" "Preta" "Amarela" "Parda" "Indígena" "Outro"

Etnia

salutation
string
Enum: "Prezado Sr." "Prezada Sra." "Prezado" "Prezada" "Amigo" "Amiga" "Caro" "Cara" "Querida" "Querido"

Saudação

Responses

Request samples

Content type
application/json
{
  • "name": "Nome X",
  • "email": "email@example.com.br",
  • "birthDate": "01/01/1991",
  • "gender": "Feminino",
  • "maritalStatus": "Solteiro",
  • "education": "Doutorado",
  • "nationality": "Brasileiro",
  • "birthPlace": "Belo Horizontino",
  • "fatherName": "Nome X",
  • "motherName": "Nome Y",
  • "zipCode": "00.000-000",
  • "countryAcronym": "BR",
  • "stateAcronym": "MG",
  • "city": "Belo Horizonte",
  • "neighborhood": "Savassi",
  • "streetName": "Rua Sobradinho",
  • "number": "1",
  • "additionalInformation": "Apto 1",
  • "phone": "(31) 33333333",
  • "cellPhone": "(31) 999999999",
  • "emergencyPhoneNumber": "(31) 999999999",
  • "personalEmail": "email@gmail.com",
  • "corporateEmail": "email@example.com.br",
  • "departamentId": 1,
  • "positionId": 1,
  • "unityId": 1,
  • "typeContract": "CLT",
  • "dateContract": "01/01/2018",
  • "contractDuration": "12 meses",
  • "contractExpirationDate": "12/09/2019",
  • "registration": "3819",
  • "senior": 1,
  • "salary": 3798.9,
  • "workShift": "Diurno",
  • "hierarchicalLevel": "Alto",
  • "dateAdmission": "01/01/2018",
  • "dateDismissal": "01/01/2018",
  • "idNumber": "22426759666",
  • "rg": "390569422",
  • "data_expedicao": "02/01/2019",
  • "orgao_expedidor": "SSP",
  • "cpf": "01234567890",
  • "voterRegistration": "282850080221",
  • "electoralZone": "131",
  • "electoralSection": "Seção 29",
  • "ctpsNum": "22426759",
  • "ctpsSerie": "2242",
  • "reservist": "39330569422",
  • "nqc": "29998619616",
  • "bank": "Bradesco",
  • "agency": "2202",
  • "checkingsAccount": "0186958-2",
  • "pis": "48348426997",
  • "disabledPerson": true,
  • "typeOfSpecialNeed": "Visual",
  • "ethnicity": "Outro",
  • "salutation": "Prezado Sr."
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Maria de Fátima Souza",
  • "idNumber": "11223344556",
  • "email": "email@example.com.br",
  • "birthDate": "01/01/1987",
  • "education": "medio_completo",
  • "course": "Arquiteura e Urbanismo",
  • "registration": "381998",
  • "gender": "Feminino",
  • "dateAdmission": "01/01/2018",
  • "dateDismissal": "02/01/2019",
  • "reasonDismissal": "Motivo da demissão",
  • "ethnicity": "Outro",
  • "workShift": "Diurno",
  • "typeContract": "CLT",
  • "senior": {
    },
  • "active": true,
  • "updated_at"": "02/01/2019",
  • "departament": {
    },
  • "position": {
    },
  • "vinculo_externos": [
    ],
  • "unity": {
    }
}

Registra demissão de um colaborador

Registra demissão de um colaborador

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único da ocorrência

Request Body schema: application/json
required

Parâmetros para registrar uma demissão.

dateDismissal
required
string <date>

data da demissão do colaborador

reasonDismissalId
integer <int64>

identificador único do motivo de demissão

formDismissal
required
string (form_dismissal)
Enum: "sem_justa_causa" "com_justa_causa" "pedido_demissao_funcionario" "acordo_entre_partes" "agrupamento_contratual" "antecipada_termo_empregado" "antecipada_termo_empregador" "aposentadoria_compulsoria" "aposentadoria_exceto_invalidez" "aposentadoria_idade" "aposentadoria_idade_tempo" "aposentadoria_invalidez" "aprendiz_ausencia_escolar" "aprendiz_inadaptacao" "contrato_nulo_art_37_cf" "culpa_reciproca" "demissao" "encerramento_empresa" "encerramento_empresa_geral" "exclusao_militar_com_efeitos" "exclusao_militar_sem_efeitos" "exoneracao" "extincao_trabalho_intermitente" "extravio_militar" "falecimento_domestico" "falecimento_empregado" "falecimento_empregador" "falecimento_empregador_opcao" "forca_maior" "mudanca_cpf" "mudanca_regime" "paralizacao_atos_autoridade" "redistribuicao" "reforma_administrativa" "reforma_militar" "remocao_orgao_declarante" "reserva_militar" "rescisao_aprendiz_inadaptacao" "rescisao_art_394_483_clt" "rescisao_indireta" "reversao_reintegracao" "termino_cessao_requisicao" "termino_contrato_termo" "termino_mandato" "transferencia_consorciado" "transferencia_domestico" "transferencia_empresa_inapta" "transferencia_grupo_empresarial" "transferencia_sucessao_empresarial" "vacancia_cargo"

forma da demissão

decisionDismissal
required
string
Enum: "pediu_saida" "demitido"

decisão da demissão

terminationAmount
number <float> <= 99999999.99

valor da recisão

Responses

Request samples

Content type
application/json
{
  • "dateDismissal": "14/07/2017",
  • "reasonDismissalId": 1,
  • "formDismissal": "sem_justa_causa",
  • "decisionDismissal": "pediu_saida",
  • "terminationAmount": 3798.9
}

Registra recontratação de um colaborador

Registra recontratação de um colaborador

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único da ocorrência

Responses

Verifica se um colaborador existe na empresa

Authorizations:
apiToken
path Parameters
cpf
required
integer >= 1
Example: 99988877766

Número do documento do colaborador

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "status": 1
}

Modifica matrícula de um colaborador

Modifica matrícula de um colaborador

Authorizations:
apiToken
path Parameters
id
required
integer

Identificador do colaborador que será atualizado.

Request Body schema: application/json
required

Parâmetros para registrar uma demissão.

registration
string

Nova matrícula do colaborador

Responses

Request samples

Content type
application/json
{
  • "registration": "123456"
}

Departamentos

Departamentos de sua empresa

Busca por todos departamentos

Listar todas os departamentos da empresa

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registra um novo departamento

Registra um novo departamento na empresa

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar um novo departamento.

name
string

nome do departamento

descricao
string

descrição do departamento

employee_id
number

Id do responsável do departamento

email
string

email do departamento

monthly_budget
number

orçamento mensal do departamento

location
string

Local do departmamento

phone
number

Telefone do departamento

fax
number

fax do departamento

extension
number

Ramal do departamento

Responses

Request samples

Content type
application/json
{
  • "name": "Administrativo",
  • "descricao": "Projeta e planeja construções urbanas",
  • "employee_id": 190299,
  • "email": "teste@teste.com",
  • "monthly_budget": 1000,
  • "location": "São Paulo",
  • "phone": 3133333333,
  • "fax": 10,
  • "extension": 1010
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "TI"
}

Busca por um departamento

Busca por um departamento

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único da departamento

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "TI"
}

Atualiza informações de um departamento

Atualiza informações de um departamento

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do departamento

Request Body schema: application/json
required

Parâmetros para registrar um novo departamento.

name
string

nome do departamento

descricao
string

descrição do departamento

employee_id
number

Id do responsável do departamento

email
string

email do departamento

monthly_budget
number

orçamento mensal do departamento

location
string

Local do departmamento

phone
number

Telefone do departamento

fax
number

fax do departamento

extension
number

Ramal do departamento

Responses

Request samples

Content type
application/json
{
  • "name": "Administrativo",
  • "descricao": "Projeta e planeja construções urbanas",
  • "employee_id": 190299,
  • "email": "teste@teste.com",
  • "monthly_budget": 1000,
  • "location": "São Paulo",
  • "phone": 3133333333,
  • "fax": 10,
  • "extension": 1010
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "TI"
}

Passaportes

Passaportes da empresa

Busca por todos passaportes

Busca por todos passaportes da empresa

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[]

Cria um novo passaporte

Cria um novo passaporte

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar um novo passaporte.

name
required
string

nome completo da pessoa que irá responder o passaporte

email
required
string

email para o qual será enviado o passaporte

sendResultToEmail
required
boolean
Default: false

se marcado como true, o resultado do teste será enviado automaticamente para o email cadastrado

expirationDate
required
string <date>

data de expiração do passaporte

blockSendingPassport
boolean

se marcado como true, bloqueia o envio do passaporte para o email do candidato

Responses

Request samples

Content type
application/json
{
  • "name": "José da Silva",
  • "email": "jose@example.com",
  • "sendResultToEmail": true,
  • "expirationDate": "12/09/2017",
  • "blockSendingPassport": true
}

Response samples

Content type
application/json
{}

Busca por um passaporte

Busca por um passaporte na empresa

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do candidato

Responses

Response samples

Content type
application/json
{}

Atualiza informações de um passaporte

Atualiza informações de um Passaporte cujo status seja não iniciado

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do passaporte

Request Body schema: application/json
required

Parâmetros para registrar um novo passaporte.

name
required
string

nome completo da pessoa que irá responder o passaporte

email
required
string

email para o qual será enviado o passaporte

sendResultToEmail
required
boolean
Default: false

se marcado como true, o resultado do teste será enviado automaticamente para o email cadastrado

expirationDate
required
string <date>

data de expiração do passaporte

blockSendingPassport
boolean

se marcado como true, bloqueia o envio do passaporte para o email do candidato

Responses

Request samples

Content type
application/json
{
  • "name": "José da Silva",
  • "email": "jose@example.com",
  • "sendResultToEmail": true,
  • "expirationDate": "12/09/2017",
  • "blockSendingPassport": true
}

Response samples

Content type
application/json
{}

Deleta um passaporte

Deleta um Passaporte cujo status seja não iniciado

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do passaporte

Responses

Relatório Profiler

Relatório Profiler obtido após responder o passaporte

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do passaporte

option
required
integer >= 1
Example: 2566

tipo de relatório. Vide Tipos de Relatórios Profiler

Responses

Response samples

Desbloqueia um passaporte

Desbloqueia um passaporte utilizando créditos da empresa, permitindo a visualização do relatório do passaporte desbloqueado

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do passaporte

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "candidato": {
    }
}

Response samples

Content type
application/json
{}

Currículos

Currículos da empresa

Busca por todos os currículos

Busca por todos os currículos da empresa

Authorizations:
apiToken
query Parameters
data_inicial
string
Example: data_inicial=01/01/2021

(opcional) Busca por currículos a partir da data específicada (dia/mes/ano)

data_final
string
Example: data_final=01/01/2022

(opcional) Busca por currículos até a data específicada (dia/mes/ano)

page
integer
Example: page=1

Indicador da página

ocultar_foto
string
Example: ocultar_foto=SIM

Ocultar foto

header Parameters
Authentication
required
string

token_api da empresa

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registra um novo currículo

Registra um novo currículo na empresa

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar um novo passaporte.

fullName
required
string

nome completo

mainEmail
required
string

email principal

secondaryEmail
string

email secundário

idNumber
required
string

cpf

gender
required
string
Enum: "Feminino" "Masculino"

gênero

phone
string

telefone

mobile
string

celular

birthDate
string <date>

data de nascimento

maritalStatus
string
Enum: "Casado" "Solteiro" "União Estável" "Divorciado" "Viúvo"

estado civil

seniority
string
Enum: "Estágio" "Trainee" "Operacional" "Supervisão" "Gerência" "Diretoria"

senioridade

skypeGtalk
string

skype ou gtalk

linkedin
string

linkedin

facebook
string

facebook

youtube
string

canal do youtube

introductionVideoURL
string

video de apresentação do candidato

origin
string

origem da entrada do candidato na empresa

zipCode
string

cep

number
string

número

street
string

Logradouro

district
string

Bairro

state
string

Estado (Sigla)

city
string

Cidade (nome)

additionalInformation
string

complemento

Array of objects (IdiomaParameters)
Array of objects (FormacaoAcademicaParameters)
Array of objects (ExperienciaProfissionalParameters)

Responses

Request samples

Content type
application/json
{
  • "fullName": "Maria de Fátima Souza",
  • "mainEmail": "principal@example.com.br",
  • "secondaryEmail": "secundario@example.com.br",
  • "idNumber": "012345678909",
  • "gender": "Feminino",
  • "phone": "(31) 33333333",
  • "mobile": "(31) 999999999",
  • "birthDate": "01/01/1987",
  • "maritalStatus": "Solteiro",
  • "seniority": "Trainee",
  • "skypeGtalk": "Fulano de Tal",
  • "linkedin": "https://www.linkedin.com/fulano",
  • "facebook": "https://www.facebook.com/fulano",
  • "youtube": "https://www.youtube.com/fulano",
  • "introductionVideoURL": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  • "origin": "Banco de talentos",
  • "zipCode": "00.000-000",
  • "number": "001",
  • "street": "Avenida Afonso Pena",
  • "district": "Centro",
  • "state": "MG",
  • "city": "Belo Horizonte",
  • "additionalInformation": "Apto 001",
  • "languages": [
    ],
  • "academicEducations": [
    ],
  • "professionalExperiences": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "fullName": "Maria de Fátima Souza",
  • "mainEmail": "principal@example.com.br",
  • "secondaryEmail": "secundario@example.com.br",
  • "idNumber": "012345678909",
  • "gender": "Feminino",
  • "phone": "(31) 33333333",
  • "mobile": "(31) 999999999",
  • "birthDate": "01/01/1987",
  • "maritalStatus": "Solteiro",
  • "seniority": "Trainee",
  • "skypeGtalk": "Fulano de Tal",
  • "linkedin": "https://www.linkedin.com/fulano",
  • "facebook": "https://www.facebook.com/fulano",
  • "youtube": "https://www.youtube.com/fulano",
  • "introductionVideoURL": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  • "origin": "Banco de talentos",
  • "photo": "iVBORw0KGgoAAAANSUhEUgAABJQAAAXWCAYAAADVTfeWAAAgAElEQVR4XuzdC5xN5f7H8",
  • "photo_extension": ".jpg",
  • "adress": {
    },
  • "languages": [
    ],
  • "notes": [
    ],
  • "professionalExperiences": [
    ],
  • "academicEducations": [
    ]
}

Busca por um currículo

Busca por um currículo na empresa

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do currículo

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deleta um curriculo

Deleta um curriculo na empresa

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do curriculo

Responses

Motivo de Demissões

Motivos de demissões de colaboradores da empresa

Busca por todos motivos de demissão

Busca por todos motivos de demissão na empresa

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registra um novo motvo de demissão

Registra um novo motivo de demissão

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar um novo motivo de demissão.

name
string

nome dado ao motivo de demissão

Responses

Request samples

Content type
application/json
{
  • "name": "Falta"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Falta"
}

Busca por um motivo de demissão

Busca por um motivo de demissão na empresa

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do motivo

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Falta"
}

Atualiza informações de um motivo de demissão

Atualiza informações de um motivo de demissão

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do motivo de demissão

Request Body schema: application/json
required

Parâmetros para registrar um novo motivo de demissão.

name
string

nome dado ao motivo de demissão

Responses

Request samples

Content type
application/json
{
  • "name": "Falta"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Falta"
}

Deleta um motivo de demissão

Deleta um motivo de demissão

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do motivo de demissão

Responses

Cargos

Cargos de sua empresa

Busca por cargos cadastrados

Busca por cargos cadastrados da empresa

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registra um novo cargo

Registra um novo cargo na empresa

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar um novo departamento.

name
string

nome do cargo

higher_id
number

Id do usuário responsável do cargo

cboCode
number

identificador do cargo superior

description
string

descrição do cargo

activies
string

atividades para esse cargo

minimumWage
number

Salário minimo para esse cargo

Responses

Request samples

Content type
application/json
{
  • "name": "Assistente adminstrativo",
  • "higher_id": 109285,
  • "cboCode": 141405,
  • "description": "Projeta e planeja construções urbanas",
  • "activies": "Projetar e planejar construções urbanas",
  • "minimumWage": 1100
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Cargo",
  • "minimumWage": 1200,
  • "briefDescription": "Breve descrição"
}

Busca por um cargo

Busca por um cargo da empresa

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do motivo

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Cargo",
  • "minimumWage": 1200,
  • "briefDescription": "Breve descrição",
  • "activities": "Atividades"
}

Atualiza informações de um cargo

Atualiza informações de um cargo

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do cargo

Request Body schema: application/json
required

Parâmetros para registrar um novo departamento.

name
string

nome do cargo

higher_id
number

Id do usuário responsável do cargo

cboCode
number

identificador do cargo superior

description
string

descrição do cargo

activies
string

atividades para esse cargo

minimumWage
number

Salário minimo para esse cargo

Responses

Request samples

Content type
application/json
{
  • "name": "Assistente adminstrativo",
  • "higher_id": 109285,
  • "cboCode": 141405,
  • "description": "Projeta e planeja construções urbanas",
  • "activies": "Projetar e planejar construções urbanas",
  • "minimumWage": 1100
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Cargo",
  • "minimumWage": 1200,
  • "briefDescription": "Breve descrição"
}

Absenteísmos

Absenteísmos de colabradores da empresa

Busca por todos absenteísmos

Busca por todos absenteísmos da empresa

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registra um novo absenteísmo

Registra um novo absenteísmo

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetros para registrar um novo absenteísmo.

dateRegistration
required
string <YYYY-MM-DD HH:MM:SS>

Horário do registro do Absenteísmo

idNumber
required
string

Número de cpf do colaborador sem formatação

type
string

Tipo de Absenteísmo

location
string

Localização no qual foi registrado o Absenteísmo

tangerinoId
string

identificador do tangerino

note
string

Observação sobre o Absenteísmo registrado

Responses

Request samples

Content type
application/json
{
  • "dateRegistration": "2018-08-19 08:20:34",
  • "idNumber": "123456789101",
  • "type": "Chegada",
  • "location": "Belo Horizonte, MG",
  • "tangerinoId": "123456789",
  • "note": "Uma observação sobre o Absenteísmo registrado"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "dateTimeAbsenteeism": "11/07/2017 08:30:00",
  • "type": "Saída",
  • "location": "Belo Horizonte",
  • "tangerinoId": 1,
  • "note": "Observação do Absenteísmo",
  • "employee": {
    }
}

Busca por um absenteísmo

Busca por um absenteísmo da empresa

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do absenteismo

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "dateTimeAbsenteeism": "11/07/2017 08:30:00",
  • "type": "Saída",
  • "location": "Belo Horizonte",
  • "tangerinoId": 1,
  • "note": "Observação do Absenteísmo",
  • "employee": {
    }
}

Atualiza informações de um absenteísmo

Atualiza informações de um absenteísmo

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do absenteísmo

Request Body schema: application/json
required

Parâmetros para registrar um novo absenteísmo.

dateRegistration
required
string <YYYY-MM-DD HH:MM:SS>

Horário do registro do Absenteísmo

idNumber
required
string

Número de cpf do colaborador sem formatação

type
string

Tipo de Absenteísmo

location
string

Localização no qual foi registrado o Absenteísmo

tangerinoId
string

identificador do tangerino

note
string

Observação sobre o Absenteísmo registrado

Responses

Request samples

Content type
application/json
{
  • "dateRegistration": "2018-08-19 08:20:34",
  • "idNumber": "123456789101",
  • "type": "Chegada",
  • "location": "Belo Horizonte, MG",
  • "tangerinoId": "123456789",
  • "note": "Uma observação sobre o Absenteísmo registrado"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "dateTimeAbsenteeism": "11/07/2017 08:30:00",
  • "type": "Saída",
  • "location": "Belo Horizonte",
  • "tangerinoId": 1,
  • "note": "Observação do Absenteísmo",
  • "employee": {
    }
}

Deleta um absenteísmo

Deleta um absenteísmo

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

identificador único do absenteísmo

Responses

Atualiza informações de um absenteísmo procurado pelo tangerino_id

Atualiza informações de um absenteísmo

Authorizations:
apiToken
path Parameters
id
required
integer >= 1
Example: 1

tangerino_id único do absenteísmo

Request Body schema: application/json
required

Parâmetros para atualizar um absenteísmo

dateRegistration
required
string <YYYY-MM-DD HH:MM:SS>

Horário do registro do Absenteísmo

idNumber
required
string

Número de cpf do colaborador sem formatação

type
string

Tipo de Absenteísmo

location
string

Localização no qual foi registrado o Absenteísmo

note
string

Observação sobre o Absenteísmo registrado

Responses

Request samples

Content type
application/json
{
  • "dateRegistration": "2018-08-19 08:20:34",
  • "idNumber": "123456789101",
  • "type": "Chegada",
  • "location": "Belo Horizonte, MG",
  • "note": "Uma observação sobre o Absenteísmo registrado"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "dateTimeAbsenteeism": "11/07/2017 08:30:00",
  • "type": "Saída",
  • "location": "Belo Horizonte",
  • "tangerinoId": 1,
  • "note": "Observação do Absenteísmo",
  • "employee": {
    }
}

Busca por absenteísmos de um colaborador

Busca por absenteísmos de um colaborador na empresa

Authorizations:
apiToken
path Parameters
cpf
required
integer
Example: 99988877766

cpf de um colaborador específico

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Profiler

Profilers de colaboradores da empresa

Busca pelos profilers dos colaboradores da empresa

Busca pelos profilers dos colaboradores da empresa

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Busca pelo profiler de um colaborador

Authorizations:
apiToken
path Parameters
id
required
number

identificador único do colaborador

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Maria de Fátima Souza",
  • "email": "email@example.com.br",
  • "gender": "Feminino",
  • "departamentId": 1,
  • "positionId": 1,
  • "dateAdmission": "01/01/2018",
  • "dateDismissal": "02/01/2019",
  • "salary": "R$ 3.890,00",
  • "workShift": "Diurno",
  • "perfil": "EA",
  • "testDate": "20/12/2017"
}

Questionários

Questionários da empresa

Responde um questionário profiler

Responde um questionário profiler fornecendo informações pessoais do candidato e as chaves identificadora dos adjetivos e desejos do candidato.

Authorizations:
apiToken
Request Body schema: application/json
required

Parâmetro de criação do questionário profiler.

name
string

Nome do candidato

email
string

Email do candidato

idNumber
number

CPF do candidato

gender
string

Sexo do candidato

start
string <date-time>

Data e hora do início do teste

end
string <date-time>

Data e hora do fim do teste

racional1
boolean

Adjetivo

rotineiro1
boolean

Adjetivo

bemquisto1
boolean

Adjetivo

destacado1
boolean

Adjetivo

pessimista1
boolean

Adjetivo

racional2
boolean

Desejo

rotineiro2
boolean

Desejo

bemquisto2
boolean

Desejo

destacado2
boolean

Desejo

pessimista2
boolean

Desejo

Responses

Request samples

Content type
application/json
{
  • "name": "Fulano",
  • "email": "fulano@email.com",
  • "idNumber": "49556733418",
  • "gender": "Feminino",
  • "start": "2019-01-21 17:10:00",
  • "end": "2019-01-21 17:19:10",
  • "racional1": true,
  • "rotineiro1": true,
  • "bemquisto1": true,
  • "destacado1": true,
  • "pessimista1": true,
  • "racional2": true,
  • "rotineiro2": true,
  • "bemquisto2": true,
  • "destacado2": true,
  • "pessimista2": true
}

Avaliação Avançadas

Avaliação avançadas de colaboradores da empresa

Avaliações avançadas por intervalo de data

Avaliações avançadas por intervalo de data

Authorizations:
apiToken
query Parameters
data_inicial
required
string
Example: data_inicial=01/01/2000

Data que representa o intervalo inicial da avaliação avançada

data_final
required
string
Example: data_final=01/01/2022

Data que representa o intervalo final da avaliação avançada

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Avaliação de Desempenho

Avaliação de desempenho de colaboradores da empresa

Avaliações de desempenho por intervalo de data

Avaliações de desempenho por intervalo de data

Authorizations:
apiToken
query Parameters
data_inicial
required
string
Example: data_inicial=01/01/2000

Data que representa o intervalo inicial da avaliação de desempenho

data_final
required
string
Example: data_final=01/01/2022

Data que representa o intervalo final da avaliação de desempenho

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Avaliações de Desempenho V3

Avaliação de Desempenho Solicitations V3

Avaliações de desempenho

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [ ],
  • "meta": {
    }
}

Avaliação de Desempenho Evaluations V3

Avaliações de desempenho

Authorizations:
apiToken
path Parameters
solicitation_id
required
integer
Example: 123654

solicitation_id específico

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [ ],
  • "meta": {
    }
}

CBO

A Classificação Brasileira de Ocupações (CBO) é um documento que retrata a realidade das profissões do mercado de trabalho brasileiro.

Busca por todos os CBOs

Lista de CBOs ativos

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tipos de Contrato

Lista de tipos de contrato.

Busca por todos os tipos de contrato

Lista de tipos de contrato

Authorizations:
apiToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Descrição API Externos

API para facilitar a integração e sincronização de informações. Com ela os sistemas externos poderão utilizar identificadores próprios quando precisarem interagir com a plataforma Sólides.

Para o funcionamento na api de externos, é necessário duas chaves, o target-system e o externo_id.

target-system:
Representa o sistema de origem dos dados – sistema HOST das informações. Deve ser passado no header de todas as requisições para API Externos e nunca deve ser vazio.

externo_id:
É a chave do registro na aplicação de origem, identifica o registro. Não pode ser duplicado para um mesmo tipo (Cargo, Departamento, Colaborador etc) e target_system. Ao enviar uma requisição a aplicação irá verificar se o externo_id/target_system estão vinculados a algum registro. Caso esteja, o mesmo será atualizado, caso contrário um novo cadastro será feito..

Externos-Cargos

Listar Cargos externos da empresa

Listar Cargos externos da empresa

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "nome": "Assistente adminstrativo",
  • "piso_salarial": 1200,
  • "cbo": "214105 - Arquiteto de edificações",
  • "descricao": "Projeta e planeja construções urbanas",
  • "atividade": "Atividades"
}

Deleta um cargo externo

Deleta um cargo externo

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador externo único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Responses

Cria ou atualiza um cargo externo

Cria ou atualiza um cargo externo

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Request Body schema: application/json
required

Parâmetros para registrar um novo Cargo.

externo_id
string

Identificador único do cargo externo

nome
string

nome do colaborador

piso_salarial
number <float>

piso salarial do cargo

cbo
string

identificador do cargo

descricao
string

descrição do cargo

atividade
string

atividades para esse cargo

Responses

Request samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "nome": "Assistente adminstrativo",
  • "piso_salarial": 1200,
  • "cbo": "214105 - Arquiteto de edificações",
  • "descricao": "Projeta e planeja construções urbanas",
  • "atividade": "Projetar e planejar construções urbanas"
}

Externos-Colaboradores

Lista Colaborador externo da empresa

Lista Colaborador externo da empresa

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador externo único do colaborador

header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Maria de Fátima Souza",
  • "email": "teste@teste.com.br",
  • "registration": 381998,
  • "birthDate": "01/01/2017",
  • "sexo": "Feminino",
  • "maritalStatus": "Solteiro",
  • "nationality": "Brasileiro",
  • "birthplace": "Belo Horizontino",
  • "motherName": "Maria",
  • "education": "Superior Completo",
  • "dateAdmission": "01/01/2018",
  • "salary": "R$ 3.890,00",
  • "dateDismissal": "02/01/2019",
  • "hierarchicalLevel": "Alto",
  • "typeContract": "CLT",
  • "dateContract": "01/01/2018",
  • "durationContract": "12 meses",
  • "contractExpirationDate": "01/01/2019",
  • "workShift": "Diurno",
  • "photo": "string",
  • "ethnicity": "Outro",
  • "senior": {
    },
  • "departament": {
    },
  • "position": {
    },
  • "address": {
    },
  • "contact": {
    },
  • "documents": {
    },
  • "vacations": {
    },
  • "dependents": {
    },
  • "healthAndSafety": {
    },
  • "benefits": {
    },
  • "observacoes": "Funcionário muito dedicado",
  • "vinculo_externos": {
    }
}

Delete Colaborador externo da empresa

Delete Colaborador externo da empresa

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador externo único do colaborador

header Parameters
Target-System
required
string

identificador único do sistema

Responses

Cria ou atualiza um colaborador externo

Cria ou atualiza um colaborador externo

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Request Body schema: application/json
required

Parâmetros para registrar um colaborador.

externo_id
string

Identificador único externo do colaborador

name
required
string

nome do colaborador

email
required
string

email do colaborador

birthDate
string <date>

data de nascimento

gender
string
Enum: "Feminino" "Masculino"

sexo do colaborador

maritalStatus
string
Enum: "Casado" "Solteiro" "União Estável" "Divorciado" "Viúvo" "Separado"

estado civil do colaborador

education
string
Enum: "Curso extra-curricular" "Fundamental Incompleto" "Fundamental Completo" "Médio Incompleto" "Médio Completo" "Superior Incompleto" "Superior Completo" "Pós Graduação" "Mestrado" "Doutorado"

escolaridade do colaborador

nationality
string

nacionalidade do colaborador

birthPlace
string

naturalidade do colaborador

fatherName
string

nome do pai

motherName
string

nome da mae

zipCode
string

cep do colaborador

countryAcronym
string

país do colaborador (Sigla)

stateAcronym
string

estado do colaborador (Sigla)

city
string

cidade do colaborador

neighborhood
string

bairro do colaborador

streetName
string

Rua do colaborador

number
string

número de endereço

additionalInformation
string

complemento do endereco

phone
string

telefone fixo

cellPhone
string

telefone celular

emergencyPhoneNumber
string

número de emergência

personalEmail
string

email pessoal

corporateEmail
string

email coorporativo

departamentId
string

identificador externo do departamento

positionId
string

identificador externo do cargo

unityId
string

identificador externo da unidade

typeContract
string
Enum: "CLT" "CLT + Comissão" "Comissionado" "Concursados" "Contrato" "Cooperado" "Efetivos" "Estagiário" "Estatuários" "Menor Aprendiz" "Jovem aprendiz" "Outros" "Parceiros" "Prestador de Serviço" "Sócio" "Temporário" "Mais Médicos" "Cedido pela União"

tipo de contrato

dateContract
string

data de início do contrato

durationContract
string

tempo de duração do contrato

contractExpirationDate
string <date>

data final do contrato

registration
string

matrícula do colaborador

senior
string

identificador externo da pessoa superior direta.

salary
number <float> <= 99999999.99

salário do colaborador

workShift
string

turno do colaborador

hierarchicalLevel
string
Enum: "Alto" "Baixo" "Médio"

nível hierárquico do colaborador

dateAdmission
string <date>

data de admissão do colaborador

dateDismissal
string <date>

data de demissão do colaborador

idNumber
string

cpf do colaboraor

rg
string

rg do colaborador

data_expedicao
string

data de expedição do rg

orgao_expedidor
string

orgão emissor do rg

cpf
required
string

CPF do colaborador

voterRegistration
string

título de eleitor do colaborador

electoralZone
string

zona eleitoral do colaborador

electoralSection
string

seção eleitoral do colaborador

ctpsNum
string

ctps num do colaborador

ctpsSerie
string

ctps serie do colaborador

reservist
string

número de reservista do colaborador

nqc
string

cnh do colaborador

bank
string

nome do banco do colaborador

agency
string

número da agência do colaborador

checkingsAccount
string

conta corrente do colaborador

pis
string

pis do colaborador

disabledPerson
boolean

Portador de Necessidade

typeOfSpecialNeed
string

Tipo de necessidade especial

ethnicity
string
Enum: "Branca" "Preta" "Amarela" "Parda" "Indígena" "Outro"

Etnia

salutation
string
Enum: "Prezado Sr." "Prezada Sra." "Prezado" "Prezada" "Amigo" "Amiga" "Caro" "Cara" "Querida" "Querido"

Saudação

Responses

Request samples

Content type
application/json
{
  • "externo_id": "1A",
  • "name": "Nome X",
  • "email": "email@example.com.br",
  • "birthDate": "01/01/1991",
  • "gender": "Feminino",
  • "maritalStatus": "Solteiro",
  • "education": "Doutorado",
  • "nationality": "Brasileiro",
  • "birthPlace": "Belo Horizontino",
  • "fatherName": "Nome X",
  • "motherName": "Nome Y",
  • "zipCode": "00.000-000",
  • "countryAcronym": "BR",
  • "stateAcronym": "MG",
  • "city": "Belo Horizonte",
  • "neighborhood": "Savassi",
  • "streetName": "Rua Sobradinho",
  • "number": "1",
  • "additionalInformation": "Apto 1",
  • "phone": "(31) 33333333",
  • "cellPhone": "(31) 999999999",
  • "emergencyPhoneNumber": "(31) 999999999",
  • "personalEmail": "email@gmail.com",
  • "corporateEmail": "email@example.com.br",
  • "departamentId": "9a35996b-44a6-4438-a662",
  • "positionId": "9a35996b-44a6-4438-a662",
  • "unityId": "9a35996b-44a6-4438-a662",
  • "typeContract": "CLT",
  • "dateContract": "01/01/2018",
  • "durationContract": "12 meses",
  • "contractExpirationDate": "12/09/2019",
  • "registration": "3819",
  • "senior": "9a35996b-44a6-4438-a662",
  • "salary": 3798.9,
  • "workShift": "Diurno",
  • "hierarchicalLevel": "Alto",
  • "dateAdmission": "01/01/2018",
  • "dateDismissal": "01/01/2018",
  • "idNumber": "22426759666",
  • "rg": "390569422",
  • "data_expedicao": "02/01/2019",
  • "orgao_expedidor": "SSP",
  • "cpf": "01234567890",
  • "voterRegistration": "282850080221",
  • "electoralZone": "131",
  • "electoralSection": "Seção 29",
  • "ctpsNum": "22426759",
  • "ctpsSerie": "2242",
  • "reservist": "39330569422",
  • "nqc": "29998619616",
  • "bank": "Bradesco",
  • "agency": "2202",
  • "checkingsAccount": "0186958-2",
  • "pis": "48348426997",
  • "disabledPerson": true,
  • "typeOfSpecialNeed": "Visual",
  • "ethnicity": "Outro",
  • "salutation": "Prezado Sr."
}

Response samples

Content type
application/json
{
  • "externo_id": "1A",
  • "name": "Maria de Fátima Souza",
  • "email": "teste@teste.com.br",
  • "birthDate": "01/01/2017",
  • "gender": "Feminino",
  • "maritalStatus": "Solteiro",
  • "education": "Superior Completo",
  • "nationality": "Brasileiro",
  • "birthplace": "Belo Horizontino",
  • "fatherName": "João",
  • "motherName": "Maria",
  • "zipCode": "00.000-000",
  • "neighborhood": "Savassi",
  • "city": "Belo Horizonte",
  • "stateAcronym": "MG",
  • "streetName": "Rua Tomé de Souza",
  • "number": 1,
  • "additionalInformation": "Apto 1",
  • "phone": "(31) 33333333",
  • "cellPhone": "(31) 999999999",
  • "emergencyPhoneNumber": "(31) 999999999",
  • "personalEmail": "email@gmail.com",
  • "corporateEmail": "email@example.com.br",
  • "departamentId": 1,
  • "positionId": 1,
  • "typeContract": "CLT",
  • "dateContract": "01/01/2018",
  • "durationContract": "12 meses",
  • "contractExpirationDate": "12/09/2019",
  • "registration": 3819,
  • "salary": 3798.9,
  • "workShift": "Diurno",
  • "hierarchicalLevel": "Alto",
  • "dateAdmission": "01/01/2018",
  • "dateDismissal": "02/01/2019",
  • "idNumber": 22426759666,
  • "rg": 390569422,
  • "data_expedicao": "02/01/2019",
  • "orgao_expedidor": "SSP",
  • "cpf": 1234567890,
  • "voterRegistration": 282850080221,
  • "electoralZone": 131,
  • "electoralSection": "Seção 29",
  • "ctpsNum": 22426759,
  • "ctpsSerie": 2242,
  • "reservist": 39330569422,
  • "nqc": 29998619616,
  • "bank": "Bradesco",
  • "agency": 2202,
  • "checkingsAccount": "0186958-2",
  • "pis": 48348426997,
  • "unityId": 1,
  • "ethnicity": "Outro"
}

Demitir um colaborador

Demitir um colaborador

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Request Body schema: application/json
required

Parâmetros para registrar um colaborador.

externo_id
string

Identificador externo do registro

dateDismissal
string

Data da demissão do(a) colaborador(a)

formDismissal
string

forma da demissão

decisionDismissal
string

decisão da demissão

reasonDismissalId
integer

identificador único do motivo de demissão

terminationAmount
number <float> <= 99999999.99

valor da recisão

Responses

Request samples

Content type
application/json
{
  • "externo_id": 1548799,
  • "dateDismissal": "14/07/2017",
  • "formDismissal": "sem_justa_causa",
  • "decisionDismissal": "pediu_saida",
  • "reasonDismissalId": 1,
  • "terminationAmount": 3798.9
}

Cria ou atualiza Informações personalidadas de um colaborador

Cria ou atualiza Informações personalidadas de um colaborador

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Request Body schema: application/json
required

Parâmetros para registrar um colaborador.

externo_id
string

Identificador externo do registro

chave_formulario
string
object

Responses

Request samples

Content type
application/json
{
  • "externo_id": 1548799,
  • "chave_formulario": "chave_formulario",
  • "customInformations": {
    }
}

Externos-Curriculos

Cria ou atualiza currículo

Cria ou atualiza currículo

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Request Body schema: application/json
required

Parâmetros para registrar um novo Cargo.

externo_id
string

Identificador externo do registro

fullName
string

Nome

mainEmail
string

e-mail Principal

secondaryEmail
string

e-mail Secundario

idNumber
string

CPF

gender
string

Genero

phone
string

Número do Telefone

mobile
string

Celular

birthDate
string

Data de Nascimento

maritalStatus
string

Estado Civil

seniority
string

Senioridade

skypeGtalk
string

Identificador externo do registro

linkedin
string

Link do Linkedin

facebook
string

Link do Facebook

youtube
string

Link do youtube

introductionVideoURL
string

Link do vídeo

origin
string

Origem

zipCode
string

CEP

number
string

Número

street
string

Nome da Rua

district
string

Bairro

state
string

Estado

city
string

Cidade

additionalInformation
string

Complemento

disabledPerson
boolean

Portador de Necessidade

object
object
object

Responses

Request samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "fullName": "Maria de Fátima Souza",
  • "mainEmail": "principal@email.com.br",
  • "secondaryEmail": "secundary@email.com.br",
  • "idNumber": 11111111111,
  • "gender": "Feminino",
  • "phone": "3123-4567",
  • "mobile": 988883333,
  • "birthDate": "01/01/2000",
  • "maritalStatus": "Solteiro",
  • "seniority": "Trainee",
  • "skypeGtalk": "nickGTalk",
  • "linkedin": "https://www.linkedin.com/fulano",
  • "facebook": "https://www.facebook.com/fulano",
  • "youtube": "https://www.youtube.com/fulano",
  • "introductionVideoURL": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  • "origin": "Banco de Talentos",
  • "zipCode": "33333-888",
  • "number": 1234,
  • "street": "Rua X",
  • "district": "Centro",
  • "state": "MG",
  • "city": "Belo Horizonte",
  • "additionalInformation": "Apto 12345",
  • "disabledPerson": true,
  • "languages": {
    },
  • "academicEducations": {
    },
  • "professionalExperiences": {
    }
}

Response samples

Content type
application/json
{
  • "id": 123456,
  • "candidato_id": null,
  • "fullName": "Maria de Fátima Souza",
  • "mainEmail": "principal@email.com.br",
  • "secondaryEmail": "secundary@email.com.br",
  • "idNumber": 11111111111,
  • "sexo": "Feminino",
  • "phone": "3123-4567",
  • "mobile": 988883333,
  • "birthDate": "01/01/2000",
  • "maritalStatus": "Solteiro",
  • "seniority": "Trainee",
  • "skypeGtalk": "nickGTalk",
  • "linkedin": "https://www.linkedin.com/fulano",
  • "facebook": "https://www.facebook.com/fulano",
  • "youtube": "https://www.youtube.com/fulano",
  • "introductionVideoURL": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  • "origin": "Banco de Talentos",
  • "zipCode": "33333-888",
  • "number": 1234,
  • "street": "Rua X",
  • "district": "Centro",
  • "state": "MG",
  • "city": "Belo Horizonte",
  • "additionalInformation": "Apto 12345",
  • "disabledPerson": true,
  • "languages": {
    },
  • "academicEducations": {
    },
  • "professionalExperiences": {
    }
}

Busca currículo externo

Busca currículo externo

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador único do sistema, pode ser id do currículo da empresa ou e-mail principal do candidato

header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Responses

Response samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "fullName": "Maria de Fátima Souza",
  • "mainEmail": "principal@email.com.br",
  • "secondaryEmail": "secundary@email.com.br",
  • "idNumber": 11111111111,
  • "sexo": "Feminino",
  • "phone": "3123-4567",
  • "mobile": 988883333,
  • "birthDate": "01/01/2000",
  • "maritalStatus": "Solteiro",
  • "seniority": "Trainee",
  • "skypeGtalk": "nickGTalk",
  • "linkedin": "https://www.linkedin.com/fulano",
  • "facebook": "https://www.facebook.com/fulano",
  • "youtube": "https://www.youtube.com/fulano",
  • "introductionVideoURL": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  • "origin": "Banco de Talentos",
  • "zipCode": "33333-888",
  • "number": 1234,
  • "street": "Rua X",
  • "district": "Centro",
  • "state": "MG",
  • "city": "Belo Horizonte",
  • "additionalInformation": "Apto 12345",
  • "disabledPerson": true,
  • "languages": [
    ],
  • "academicEducations": [
    ],
  • "professionalExperiences": [
    ]
}

Externos-Departamentos

Lista departamento externo

Lista departamento externo

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Responses

Response samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "name": "TI",
  • "employee_id": 123
}

Deleta um departamento externo

Deleta um departamento externo

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador externo único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Responses

Cria ou atualiza um novo departamento externo

Cria ou atualiza um novo departamento externo

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Accept
string

Conteúdo a ser enviado

Content-Type
string

Conteúdo a ser enviado

Request Body schema: application/json
required

Criar Departamento.

externo_id
string

Identificador único do cargo externo

name
string

Nome do departamento

employee_id
integer

Identificador externo do colaborador responsável

Responses

Request samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "name": "TI",
  • "employee_id": 123
}

Response samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "name": "TI",
  • "employee_id": 123
}

Externos-Sucessão

Lista de posições externo por externo_id

Lista de posições externo por externo_id

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Responses

Response samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "numero_posicao": 50,
  • "amei": "amei1",
  • "buscar_mercado": false,
  • "buscar_mercado_nome": "",
  • "colaborador_matricula": 123456,
  • "colaborador_nome": "João Silva Souza",
  • "derivado_outro": "Derivado",
  • "designacao_local_posicao": "desig -local",
  • "designacao_posicao_grupo": "Desig Grupo",
  • "gg_unit": "gg_unit",
  • "local_posicao": "Local Posicao",
  • "local_site": "Local Site",
  • "position_career": "Posição Carreira",
  • "rh_bp": "RH BP",
  • "vp_diretoria": "VP Diretoria",
  • "cargo": {
    },
  • "colaborador": {
    },
  • "departamento": {
    }
}

Delete posições externo

Delete posições externo

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Responses

Lista de posições externo

Lista de posições externo

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cria ou atualiza posições externas

Cria ou atualiza posições externas

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Accept
string
Content-Type
string

Tipo de conteúdo

Request Body schema: application/json
required

Parâmetros para registrar um novo Cargo.

externo_id
integer

Identificador único do departamento

numero_posicao
string

Número de posições

amei
string
buscar_mercado
boolean
buscar_mercado_nome
string
colaborador_matricula
number

Matrícula do colaborador

colaborador_nome
string

Nome do colaborador

derivado_outro
string
designacao_local_posicao
string
designacao_posicao_grupo
string
gg_unit
string
local_posicao
string
local_site
string
position_career
string
rh_bp
string
vp_diretoria
string
cargo_id
number

Id do Cargo

colaborador
number

Id do Colaborador

departamento
number

Id do Departamento

Responses

Request samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "numero_posicao": 5008,
  • "amei": "amei1",
  • "buscar_mercado": false,
  • "buscar_mercado_nome": "",
  • "colaborador_matricula": 123456,
  • "colaborador_nome": "João Silva Souza",
  • "derivado_outro": "Derivado",
  • "designacao_local_posicao": "desig -local",
  • "designacao_posicao_grupo": "Desig Grupo",
  • "gg_unit": "gg_unit",
  • "local_posicao": "Local Posicao",
  • "local_site": "Local Site",
  • "position_career": "Posição Carreira",
  • "rh_bp": "RH BP",
  • "vp_diretoria": "VP Diretoria",
  • "cargo_id": 123456,
  • "colaborador": 123456,
  • "departamento": 123456
}

Externos-Unidades

Lista de unidades externo por externo_id

Lista de unidades externo por externo_id

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Content-Type
string

Tipo de conteúdo

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Tecnologia"
}

Delete de unidades externo por externo_id

Delete de unidades externo por externo_id

Authorizations:
apiToken
path Parameters
externo_id
required
string

identificador único do cargo

header Parameters
Target-System
required
string

identificador único do sistema

Content-Type
string

Tipo de conteúdo

Responses

Cria ou atualiza unidades

Cria ou atualiza unidades

Authorizations:
apiToken
header Parameters
Target-System
required
string

identificador único do sistema

Content-Type
string

Tipo de conteúdo

Request Body schema: application/json
required

Parâmetros para registrar uma nova unidade.

externo_id
integer

Identificador único da unidade

name
string

Nome da unidade

Responses

Request samples

Content type
application/json
{
  • "externo_id": "externo_id",
  • "name": "Tecnologia"
}

Externos-Vinculo Externo

Lista Vinculo Externo

Lista Vinculo Externo

Authorizations:
apiToken
header Parameters
Content-Type
string

Tipo de conteúdo

Accept
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cria ou atualiza Vinculo Externo

Cria ou atualiza Vinculo Externo

Authorizations:
apiToken
header Parameters
Content-Type
string

Conteúdo a ser enviado

Accept
string
Request Body schema: application/json
required

Parâmetros para registrar um novo vinculo.

Array of objects (Vinculo_Externos@criar)

Responses

Request samples

Content type
application/json
{
  • "vinculo_externos": [
    ]
}

Externos-Profiler

Cria ou atualiza Profiler

Cria ou atualiza Profiler

Authorizations:
apiToken
header Parameters
Accept
string
Request Body schema: application/json
required

Parâmetros para registrar um novo Cargo.

name
string
email
string
idNumber
number
gender
string
tipo_relatorio
string
start
string
end
string
C821
boolean
alegre1
boolean
animado1
boolean
ativo1
boolean
audacioso1
boolean
autodisciplinado1
boolean
barulhento1
boolean
bemhumorado1
boolean
C822
boolean
alegre2
boolean
animado2
boolean
ativo2
boolean
audacioso2
boolean
autodisciplinado2
boolean
autosuficiente2
boolean
barulhento2
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Usuario Teste",
  • "email": "usuarioteste@mail.com",
  • "idNumber": 12365445585,
  • "gender": "Feminino",
  • "tipo_relatorio": "simples",
  • "start": "2020-01-21 16:00:00",
  • "end": "2020-01-21 16:10:00",
  • "C821": true,
  • "alegre1": true,
  • "animado1": true,
  • "ativo1": true,
  • "audacioso1": true,
  • "autodisciplinado1": true,
  • "barulhento1": true,
  • "bemhumorado1": true,
  • "C822": true,
  • "alegre2": true,
  • "animado2": true,
  • "ativo2": true,
  • "audacioso2": true,
  • "autodisciplinado2": true,
  • "autosuficiente2": true,
  • "barulhento2": true
}

Descrição Webhook

Webhooks dão aos clientes a possibilidade de se cadastrarem para receberem requisições web mediante determinados acontecimentos no Gestão (eventos), os eventos somente são enviados em ambiente de produção.

Configuração
A configuração do webhook se dá dentro do gestão basta acessar o menu Configurações >> Configuração do Webhook, onde será possível a criação do endpoint informando a URL, o evento, Ativação e desativação alem da configuração dos headers.

Headers
Quando se cadastra um webhook no gestão há a possibilidade de se informar os headers que serão enviados. Os Headers são valores fixos.

Eventos Disponíveis
Quando um Webhook é cadastrado, os eventos disponiveis para disparo são

  • novo_colaborador
  • edicao_colaborador
  • demissao_colaborador
  • nova_ocorrencia
  • nova_resposta_pesquisa
  • novo_curriculo

novo_colaborador

Sempre que um colaborador é criado no gestão, o Webhook é enviado com o seguinte payload: 

  {
    "acao": "novo_colaborador",
    "data_criacao": "11/01/2022 11:49:19 ",
    "dados":{ 
      "nome": "Valentina G. F. N. ",
      "email": "v_n@localhost.com ",
      "matricula": " ",
      "data_nascimento": "01/01/1993 ",
      "sexo": "Feminino ",
      "estado_civil": " ",
      "nacionalidade": " ",
      "naturalidade": " ",
      "nome_pai": " ",
      "nome_mae": " ",
      "pne":false, 
      "escolaridade": "Curso extra-curricular ",
      "saudacao": " ",
      "data_admissao": "11/01/2022 ",
      "salario": "R$ 0,00 ",
      "total_beneficios": "R$ 0,00 ",
      "data_demissao": " ",
      "grau_hierarquico": "Alto ",
      "tipo_contrato": " ",
      "data_contrato": " ",
      "duracao_contrato": " ",
      "vencimento_contrato": " ",
      "turno": " ",
      "criado_em": "11/01/2022 11:47:46 ",
      "atualizado em": "11/01/2022 11:47:46 ",
      "departamento":{ 
        "id":29381, 
        "nome": "A.R.G. SA - APOIO ADMINIST CENTRAL ",
        "vinculo_externos":[]
      }, 
      "cargo":{ 
        "id":64848, 
        "nome": "A-HISTORICO ",
        "piso_salarial": "R$ 0,00 ",
        "vinculo_externos":[]
      }, 
      "endereco":{ 
        "cep":null, 
        "logradouro":null, 
        "complemento":null, 
        "numero":null, 
        "bairro":null
      }, 
      "contato":{ 
        "telefone":null, 
        "celula":null, 
        "emergencia":null, 
        "emai":null, 
        "email_empresaria":null
      }, 
      "documentos":{ 
        "cpf": "60353418102 ",
        "rg": " ",
        "titulo_eleitor": " ",
        "zona_eleitoral": " ",
        "secao_eleitoral": " ",
        "ctps_num": " ",
        "ctps_serie": " ",
        "reservista": " ",
        "cnh": " ",
        "banco": " ",
        "agencia": " ",
        "conta_corrente": " ",
        "pis": " "
      }, 
      "observacoes":[], 
      "vinculo_externos":[]
    }
  }

edicao_colaborador

Sempre que um colaborador é editado no gestão, o Webhook é enviado com o seguinte payload: 

  {
    "acao":"edicao_colaborador",
    "data_criacao":"11/01/2022 09:14:01",
    "dados":{
      "nome":"José Pereira Silva",
      "email":"email@exemplo.com",
      "matricula":"123",
      "data_nascimento":"15/05/1969",
      "sexo":"Feminino",
      "estado_civil":"Casado",
      "nacionalidade":"",
      "naturalidade":"",
      "nome_pai":"",
      "nome_mae":"",
      "pne":false,
      "escolaridade":"Médio Completo",
      "saudacao":"",
      "data_admissao":"01/12/1998",
      "salario":"R$ 0,00",
      "total_beneficios":"R$ 0,00",
      "data_demissao":"",
      "grau_hierarquico":"Baixo",
      "tipo_contrato":"",
      "data_contrato":"",
      "duracao_contrato":"",
      "vencimento_contrato":"",
      "turno":"",
      "criado_em":"04/07/2019 09:58:59",
      "atualizado em":"11/01/2022 09:14:01",
      "departamento":{
        "id":123456,
        "nome":"Pesquisa",
        "vinculo_externos":[]
      },
      "cargo":{
        "id":123456,
        "nome":"TECNICO EM DOCUMENTAÇÃO",
        "piso_salarial": null,
        "descricao": null
        "atividades": null
        "vinculo_externos":[]
      },
      "endereco":{
        "cep":null,
        "logradouro":null,
        "complemento":null,
        "numero":null,
        "bairro":null
      },
      "contato":{
        "telefone":null,
        "celular":null,
        "emergencia":null,
        "email":null,
        "email_empresarial":null
      },
      "documentos":{
        "cpf":"12345678912",
        "rg":"1234568",
        "titulo_eleitor":"",
        "zona_eleitoral":"",
        "secao_eleitoral":"",
        "ctps_num":"",
        "ctps_serie":"",
        "reservista":"",
        "cnh":"",
        "banco":"",
        "agencia":"",
        "conta_corrente":"",
        "pis":""
      },
      "observacoes":[],
      "vinculo_externos":[]
    }
  }

demissao_colaborador

Sempre que um colaborador é demitido no gestão, o Webhook é enviado com o seguinte payload: 

  {
    "acao":"demissao_colaborador",
    "data_criacao":"29/12/2021 09:15:44",
    "dados":{
      "nome":"José Pereira Silva",
      "email":"email@exemplo.com",
      "matricula":"123",
      "data_nascimento":"15/05/1969",
      "sexo":"Feminino",
      "estado_civil":"Casado",
      "nacionalidade":"",
      "naturalidade":"",
      "nome_pai":"",
      "nome_mae":"",
      "pne":false,
      "escolaridade":"Médio Completo",
      "saudacao":"",
      "data_admissao":"01/12/2021",
      "salario":"R$ 0,00",
      "total_beneficios":"R$ 0,00",
      "data_demissao":"01/12/2022",
      "grau_hierarquico":"Baixo",
      "tipo_contrato":"",
      "data_contrato":"",
      "duracao_contrato":"",
      "vencimento_contrato":"",
      "turno":"",
      "criado_em":"04/07/2019 09:58:59",
      "atualizado em":"11/01/2022 09:14:01",
      "departamento":{
        "id":123456,
        "nome":"Pesquisa",
        "vinculo_externos":[]
      },
      "cargo":{
        "id":40740,
        "nome":"LIDER",
        "piso_salarial":"R$ 2.000,00",
        "descricao": null
        "atividades": null
        "vinculo_externos":[]
      },
      "endereco":{
        "cep":"12345123",
        "logradouro":"Rua 01",
        "complemento":null,
        "numero":"1139",
        "bairro":"Nova Cachoeirinha",
        "cidade":{
          "nome":"Belo Horizonte",
          "estado":{
            "nome":"Minas Gerais",
            "sigla":"MG"
          }
        }
      },
      "contato":{
        "telefone":null,
        "celular":null,
        "emergencia":null,
        "email":null,
        "email_empresarial":null
      },
      "documentos":{
        "cpf":"12345678912",
        "rg":"1234568",
        "titulo_eleitor":"",
        "zona_eleitoral":"",
        "secao_eleitoral":"",
        "ctps_num":"",
        "ctps_serie":"",
        "reservista":"",
        "cnh":"",
        "banco":"",
        "agencia":"",
        "conta_corrente":"",
        "pis":""
      },
      "observacoes":[],
      "vinculo_externos":[]
    }
  }

nova_ocorrencia

Sempre que uma ocorrência é atribuída á um colaborador no gestão, o Webhook é enviado com o seguinte payload: 

  {
    "acao":"nova_ocorrencia",
    "data_criacao":"19/10/2021 22:26:45",
    "dados":{
      "colaborador_nome":"José Pereira da Silva",
      "colaborador_email":"email@exemplo.com.br",
      "data_ocorrencia":"20/10/2021",
      "classificacao":"Neutro",
      "comentario":"Ausência Justificada",
      "valor":"0,00",
      "tipo_ocorrencia":"Falta/Ausência"
    }
  }

nova_resposta_pesquisa

Sempre que uma resposta de uma pesquisa é registrado no gestão, o Webhook é enviado com o seguinte payload: 

  {
    "acao": "nova_resposta_pesquisa",
    "data_criacao": "13/07/2020 16:22:59",
    "dados":{
      "pesquisa_id": 403370,
      "descricao_Pesquisa": "Este é um convite para reflexão sobre alguns pilares estratégicos sobre sua carreira 
      "titulo_pesquisa": "Carreira 2020",
      "criado_em": "13/07/2020 20:22:59",
      "respostas":[
        {
          "pergunta_id": 123456,
          "pergunta": "Quais são os seus objetivos de carreira de curto, médio e longo prazo?",
          "pergunta_posicao": 0,
          "resposta": "Curto prazo é permanecer como Gerente de Engenharia, Manutenção e Utilidades
          "alternativa_id": null,
          "numero_alternativa": null
        },
        {
          "pergunta_id": 15140989,
          "pergunta": "Face aos seus objetivos de carreira, o que você considera como seus pontos fortes? 
          "pergunta_posicao": 1,"resposta": "Como meus pontos fortes destaco a Liderança, assim como o Comprometimento e a Confiança.
          "alternativa_id": null,
          "numero_alternativa": null
        }
      ],
      "respondente": {
        "id": 123456,
        "nome": "Antonio Pereira Silva",
        "vinculo_externos": [
          {
            "externo_id": null,
            "target_system": null
          }
        ]
      }
    }
  }

novo_curriculo

Sempre que um currículo é criado no gestão, o Webhook é enviado com o seguinte payload: 

  {
    "acao":"novo_curriculo",
    "data_criacao":"05/05/2022 10:55:53",
    "dados":{
      "nome_completo":"Valentina Campos",
      "email_principal":"valentinac@localhost.com",
      "email_secundario":"",
      "sexo":"feminino",
      "telefone":"(31) 3333-3333",
      "celular":"(31) 99999-9999",
      "skype_gtalk":"skype/gc",
      "linkedin":"linkedin/gc",
      "facebook":"facebook/gc",
      "youtube":"youtube/gc",
      "data_nascimento":"01/01/1990 00:00:00",
      "estado_civil":"Casado",
      "senioridade":"directors",
      "created_at":"05/05/2022 10:55:53",
      "updated_at":"05/05/2022 10:55:53",
      "endereco":{
        "cep":"12.345-678",
        "logradouro":"Rua 01",
        "complemento":"Casa",
        "numero":"280",
        "bairro":"Santana do Norte",
        "cidade":{
          "nome":"Belo Horizonte",
          "estado":{
            "nome":"Minas Gerais",
            "sigla":"MG"
          }
        }
      },
      "cpf":"12345678910",
      "contratado":false,
      "portador_necessidade":false,
      "tipo_necessidade_especial":"",
      "banco_talento":false,
      "pretensao_salarial":"12000.0",
      "favoritado":false,
      "visualizado":false,
      "url_video_apresentacao":"youtube/gc/1214@#$$",
      "origem":"Jobs",
      "sobre_mim":"",
      "nacionalidade":"Brasileiro",
      "naturalidade":"Belo Horizonte",
      "cnh":"12312121322313213",
      "cnh_categoria":"AB",
      "cnh_data_emissao":"05/05/2022 00:00:00",
      "cnh_data_primeira_habilitacao":"05/05/2022 00:00:00",
      "cnh_uf":"Rio Grande do Sul",
      "rg":null,
      "ctps_num":"123456",
      "ctps_serie":"55",
      "instagram":"instagram/gc",
      "twitter":null,
      "whatsapp":null,
      "primeiro_emprego":null,
      "turno":null,
      "fds_feriado":null,
      "escolaridade":"curso",
      "banido":false,
      "banido_em":"",
      "portador_deficiencia":false,
      "tipo_deficiencia":null,
      "adaptacao_necessidade_especial":null,
      "url_portfolio":null,
      "telefone_ddi":"55",
      "whatsapp_ddi":"55"
    }
  }