Skip to content

Retorna uma lista com os afastamentos de um funcionário

Request

Os afastamentos retornados, conforme os filtros aplicados são associados a um funcionário identificado por employee_id. Eles representam variados motivos que fazem com que o funcionário deixe de trabalhar o tempo previsto. Retorna todos os registros de afastamentos que contenham as datas entre start_date e end_date. Resultado paginado

Security
BasicAuth
Query
employee_idstring

ID do funcionário. Obrigatório caso employee_external_id não esteja presente.

employee_external_idstring

ID externo do funcionário. Obrigatório caso employee_id não esteja presente.

start_datestring, (date)(DateParamModel)required

Filtro para data de início dos afastamentos.

Example:start_date=2023-09-27
end_datestring, (date)(DateParamModel)required

Filtro para data de fim dos afastamentos

Example:end_date=2023-09-27
typestring(TipoAfastamentoModel)

filtro por tipo de afastamento.

Enum:"abono""afastamento""atestado""dispensa_legal""falta_justificada""falta_injustificada""ferias""folga""inss""suspensao"
statusstring(StatusAfastamentoModel)

filtro por situação do afastamento.

Enum:"aprovado""pendente""reprovado"
max_resultsinteger(MaxResultsParamModel)

Tamanho da página de resultados paginados.

Default:25
pageinteger(PageParamModel)

Número da página de resultados a retornar

Default:1
curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/work-leaves?employee_id=string&employee_external_id=string&start_date=2023-09-27&end_date=2023-09-27&type=abono&status=aprovado&max_results=25&page=1'

Responses

Retorna listagem de todos os afastamentos que atendem aos critérios dos filtros.

Bodyapplication/json
_itemsArray of objects(AfastamentoModel)
_metaobject(MetaModel)
Response
{
  "_items": [
    { … }
  ],
  "_links": {
    "parent": { … },
    "self": { … }
  },
  "_meta": {
    "max_results": 0,
    "page": 0,
    "total": 0
  }
}