Skip to content

Lista o cadastro dos funcionários ativos

Request

Resultado paginado. A ausência de um campo na resposta indica que seu valor ainda não foi definido. Pode ser filtrado por empregador (payment_source), útil para localizar funcionários de um empregador específico que ainda não possuem external_id. Quando nenhum funcionário é encontrado, a resposta é 200 com _items vazio.

Security
BasicAuth
Query
payment_sourcestring

Filtra os funcionários pelo _id do empregador (payment-source) vinculado. Deve ser um ObjectId válido.

Example:payment_source=5f3551beeb623e8ebe0ae994
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/employees?payment_source=5f3551beeb623e8ebe0ae994&max_results=25&page=1'

Responses

Lista de funcionários. Quando nenhum funcionário atende à consulta, o retorno também é 200, com _items vazio e _meta.total igual a 0.

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