Skip to content

Retorna os detalhes de um funcionário

Request

São retornados os funcionário ativos apenas.

Security
BasicAuth
Path
idstringrequired

ID do funcionário. Pode ser usado tanto _id quanto external_id

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/employees/{id}'

Responses

Lista de funcionários.

Bodyapplication/json
_idstring

Identificador único do recurso, gerado internamente.

_createdstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example:"2024-09-29T08:00-03:00"
_updatedstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example:"2024-09-29T08:00-03:00"
_etagstring(EtagModel)

Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos

external_idstring

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

full_namestring

Nome completo.

cpfstring^\d{11}$

CPF do funcionário, somente números. Exclusivo com CNPJ.

Example:"01234567890"
cnpjstring^\d{14}$

CNPJ em caso de prestador de serviço autônomo. Exclusivo com CPF.

Example:"41443245000170"
nisstring^\d{11}$

Código NIS/PIS do funcionário, somente números.

Example:"12345678901"
mobile_phonestring

Número de telefone celular com código de área, somente números.

Example:"11991234567"
work_schedulestring^[0-9a-fA-F]{24}$

ID da escala de trabalho. Não pode ser removido. Referência para work-schedules.

Example:"5ebee54eee1767f30129e61c"
phone_country_codestring

Código de país para telefone celular.

Default:"55"
Example:"55"
emailstring^[a-zA-Z0-9.!#$%&’*+/=?^_{|}~-]+@[a-zA-Z0-9-]...
Example:"exemplo@tiquetaque.com"
birth_datestring, (date)

Data de nascimento.

citystring

Cidade de alocação do funcionário para fins de feriados utilizados na contabilização de horas.

Example:"São Paulo"
statestring

Estado da cidade de alocação.

Example:"SP"
timezonestring(TimezoneModel)

Fuso Horário utilizado para controle do horário de registro de ponto.

Enum:"America/Araguaina""America/Bahia""America/Belem""America/Boa_Vista""America/Campo_Grande""America/Cuiaba""America/Eirunepe""America/Noronha""America/Fortaleza""America/Maceio"
Example:"America/Sao_Paulo"
contract_dataobject
Response
{
  "_id": "string",
  "_created": "2024-09-29T08:00-03:00",
  "_updated": "2024-09-29T08:00-03:00",
  "_etag": "string",
  "external_id": "string",
  "full_name": "string",
  "cpf": "01234567890",
  "cnpj": "41443245000170",
  "nis": "12345678901",
  "mobile_phone": "11991234567",
  "work_schedule": "5ebee54eee1767f30129e61c",
  "phone_country_code": "55",
  "email": "exemplo@tiquetaque.com",
  "birth_date": "2019-08-24",
  "city": "São Paulo",
  "state": "SP",
  "timezone": "America/Sao_Paulo",
  "send_app_link": false,
  "contract_data": {
    "registration_number": "string",
    "payment_source": "5ebee54eee1767f30129e61c",
    "manager": "5f5bc225b511a6edec2891f7",
    "admission_date": "2019-08-24",
    "dismissal_date": "2019-08-24",
    "records_start_date": "2019-08-24",
    "hour_rate_cents": 1,
    "department": "string",
    "job_role": "string",
    "allow_electronic_signature": true,
    "app_auto_approve": false,
    "web_auto_approve": false,
    "qrcode_auto_approve": false,
    "face_auto_approve": false,
    "geo_auto_approve": false,
    "manual_auto_approve": false,
    "work_leave_auto_approve": false,
    "offline_auto_approve": false,
    "requires_geotag": false,
    "requires_web_photo": false,
    "enabled_geofence": false,
    "requires_justification": false,
    "requires_work_leave_justification": false,
    "allow_web_record": false,
    "allow_face_record": false,
    "allow_manual_record": false,
    "allow_offline_record": false,
    "allow_work_leave_record": false,
    "allow_vacation_work_leave_record": false,
    "allow_app_record": false,
    "allow_qrcode_record": false,
    "allow_external_api_record": true,
    "allow_face_store": false,
    "allow_access_app": false,
    "allow_access_web": false
  }
}