# Lista o cadastro dos funcionários ativos Resultado paginado. A ausência de um campo na resposta indica que seu valor ainda não foi definido. Endpoint: GET /employees Version: 2.1 Security: BasicAuth ## Query parameters: - `max_results` (integer) Tamanho da página de resultados paginados. - `page` (integer) Número da página de resultados a retornar ## Response 200 fields (application/json): - `_items` (array) - `_items._id` (string) Identificador único do recurso, gerado internamente. - `_items._created` (string) Example: "2024-09-09T08:00-03:00" - `_items._updated` (string) Example: "2024-09-09T08:00-03:00" - `_items.external_id` (string) 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 (""). - `_items.full_name` (string) Nome completo. - `_items.cpf` (string) CPF do funcionário, somente números. Exclusivo com CNPJ. Example: 1234567890 - `_items.cnpj` (string) CNPJ em caso de prestador de serviço autônomo. Exclusivo com CPF. Example: 41443245000170 - `_items.nis` (string) Código NIS/PIS do funcionário, somente números. Example: "12345678901" - `_items.mobile_phone` (string) Número de telefone celular com código de área, somente números. Example: "11991234567" - `_items.work_schedule` (string) ID da escala de trabalho. Não pode ser removido. Referência para work-schedules. Example: "5ebee54eee1767f30129e61c" - `_items.phone_country_code` (string) Código de país para telefone celular. Example: "55" - `_items.email` (string) Example: "exemplo@tiquetaque.com" - `_items.birth_date` (string) Data de nascimento. - `_items.city` (string) Cidade de alocação do funcionário para fins de feriados utilizados na contabilização de horas. Example: "São Paulo" - `_items.state` (string) Estado da cidade de alocação. Example: "SP" - `_items.timezone` (string) 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", "America/Manaus", "America/Porto_Velho", "America/Recife", "America/Rio_Branco", "America/Santarem", "America/Sao_Paulo", "Africa/Algiers", "Europe/Amsterdam", "Europe/Athens", "Pacific/Auckland", "Asia/Bangkok", "Europe/Berlin", "America/Bogota", "Europe/Brussels", "America/Argentina/Buenos_Aires", "Egypt", "Asia/Kolkata", "America/Caracas", "Asia/Dubai", "Europe/Dublin", "Africa/Casablanca", "US/Central", "America/Mexico_City", "US/Mountain", "America/Guatemala", "Europe/Helsinki", "Pacific/Honolulu", "Europe/Istanbul", "Asia/Jerusalem", "America/Lima", "Europe/Lisbon", "Europe/London", "US/Pacific", "Europe/Madrid", "Europe/Moscow", "Africa/Nairobi", "US/Eastern", "Europe/Paris", "Europe/Prague", "Europe/Rome", "America/Santiago", "Asia/Seoul", "Australia/Sydney", "Asia/Tokyo", "America/Toronto", "America/Vancouver", "Europe/Vienna", "Asia/Shanghai", "Europe/Zurich" - `_items.send_app_link` (boolean) Enviar por e-mail, no momento da criação, as instruções de uso do app mobile para o funcionário. - `_items.contract_data` (object) - `_items.contract_data.registration_number` (string) Código de matrícula. - `_items.contract_data.payment_source` (string) ID do empregador deste funcionário. Não pode ser removido. Referência para payment-sources. Example: "5ebee54eee1767f30129e61c" - `_items.contract_data.manager` (string) ID do gestor deste funcionário. Referência externa para qualquer documento de usuário /users. Example: "5f5bc225b511a6edec2891f7" - `_items.contract_data.admission_date` (string) Data de admissão. - `_items.contract_data.dismissal_date` (string) Data de desligamento. - `_items.contract_data.records_start_date` (string) Data de início dos registros. - `_items.contract_data.hour_rate_cents` (integer) Valor hora em centavos utilizado para cálculos de valor de horas extras. - `_items.contract_data.department` (string) Departamento - `_items.contract_data.job_role` (string) Cargo - `_items.contract_data.allow_electronic_signature` (boolean) Permite que o funcionário realize a assinatura eletrônica do espelho de ponto. - `_items.contract_data.app_auto_approve` (boolean) Configura aprovação automática de registros realizados via app. - `_items.contract_data.web_auto_approve` (boolean) Configura aprovação automática de registros realizados via web. - `_items.contract_data.face_auto_approve` (boolean) Configura aprovação automática de registros realizados com reconhecimento facial. - `_items.contract_data.geo_auto_approve` (boolean) Configura aprovação automática de registros realizados que contenham geolocalização. - `_items.contract_data.manual_auto_approve` (boolean) Configura aprovação automática de ajustes de ponto manuais. - `_items.contract_data.work_leave_auto_approve` (boolean) Configura aprovação automática para criação de afastamentos. - `_items.contract_data.offline_auto_approve` (boolean) Configura aprovação automática para registros off-line via app. - `_items.contract_data.requires_geotag` (boolean) Faz com que seja necessário o envio de dados de geolocalização para o registro de ponto. - `_items.contract_data.requires_web_photo` (boolean) Faz com que seja necessário o envio de foto para o registro de ponto. - `_items.contract_data.enabled_geofence` (boolean) Habilita a verificação de perímetros para o registro de ponto. - `_items.contract_data.requires_justification` (boolean) Obriga o preenchimento de uma justificativa para ajustes manuais. - `_items.contract_data.requires_work_leave_justification` (boolean) Obriga o preenchimento de uma justificativa para a criação de afasfamentos. - `_items.contract_data.allow_web_record` (boolean) Permite a realização de registros de ponto via web. - `_items.contract_data.allow_face_record` (boolean) Permite a realização de registros de ponto através de reconhecimento facial. - `_items.contract_data.allow_manual_record` (boolean) Permite a realização de ajustes manuais pelo funcionário. - `_items.contract_data.allow_offline_record` (boolean) Permite a realização de registros de ponto off-line. - `_items.contract_data.allow_work_leave_record` (boolean) Permite a criação de registros de afastamento exceto férias pelo funcionário. - `_items.contract_data.allow_vacation_work_leave_record` (boolean) Permite a criação de registros de afastamento do tipo férias pelo funcionário. - `_items.contract_data.allow_app_record` (boolean) Permite a realização de registros de ponto via app. - `_items.contract_data.allow_qrcode_record` (boolean) Permite a realização de registros de ponto via TiQR Code. - `_items.contract_data.allow_external_api_record` (boolean) Permite a realização de registros de ponto para o funcionário através desta API. - `_items.contract_data.allow_face_store` (boolean) Permite que o funcionário cadastre o rosto para reconhecimento facial através do seu app. - `_items.contract_data.allow_access_app` (boolean) Permite acesso ao aplicativo de funcionários. - `_items.contract_data.allow_access_web` (boolean) Permite acesso web ao funcionário. - `_links` (object) - `_links.parent` (object) - `_links.parent.href` (string) - `_links.parent.title` (string) - `_links.self` (object) - `_meta` (object) - `_meta.max_results` (integer) - `_meta.page` (integer) - `_meta.total` (integer) ## Response 401 fields (application/json): - `_code` (integer) Código de erro interno. - `_status` (string) Example: "ERR" - `_error` (object) - `_error.code` (integer) Codigo de erro HTTP. - `_error.message` (string) Mensagem de erro interna. - `_error._ui_message` (string) Mensagem de erro para o usuário. ## Response 404 fields (application/json): - `_code` (integer) Código de erro interno. - `_status` (string) Example: "ERR" - `_error` (object) - `_error.code` (integer) Codigo de erro HTTP. - `_error.message` (string) Mensagem de erro interna. - `_error._ui_message` (string) Mensagem de erro para o usuário.