Skip to content

API pública TiqueTaque (2.1)

Autenticação

Para todas as requisições é necessária a autenticação com um token gerado a partir da plataforma do gestor, utilizando o token com autenticação **BasicAuth** sendo user=*public*, senha=*seu_token*. Verifique a seção de integrações do TiqueAdmin para gerar o token.

Rate limiting

Requisições são limitadas a 60 requisições por janela deslizante de 1 minuto. Se o limite for excedido, será retornada uma resposta HTTP 429 Too Many Requests.
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://api-docs.tiquetaque.app/_mock/openapi
https://api.tiquetaque.com/v2.1

Afastamentos

Operações referentes aos afastamentos de um funcionário.

Operations

Escalas

Informações dos cadastros de escalas de trabalho.

Operations

Funcionários

Operações sobre os cadastros de funcionários.

Operations

Cadastra um novo funcionário

Request

Para detalhes dos formatos de dados do corpo da requisição, veja a descrição do schema.

Security
BasicAuth
Bodyapplication/json
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_namestringrequired

Nome completo.

cpfstring^d{11}$

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

Example: 1234567890
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(?i)[0-9a-f]{24}\Z

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_dateany(date)

Data de nascimento.

citystringrequired

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

Example: "São Paulo"
statestringrequired

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"
send_app_linkboolean

Enviar por e-mail, no momento da criação, as instruções de uso do app mobile para o funcionário.

Default false
contract_dataobject
curl -i -X POST \
  -u <username>:<password> \
  https://api-docs.tiquetaque.app/_mock/openapi/employees \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "string",
    "full_name": "string",
    "cpf": 1234567890,
    "cnpj": 41443245000170,
    "nis": 12345678901,
    "mobile_phone": 11991234567,
    "work_schedule": "5ebee54eee1767f30129e61c",
    "phone_country_code": 55,
    "email": "exemplo@tiquetaque.com",
    "birth_date": null,
    "city": "São Paulo",
    "state": "SP",
    "timezone": "America/Sao_Paulo",
    "send_app_link": false,
    "contract_data": {
      "payment_source": "5ebee54eee1767f30129e61c",
      "manager": "5f5bc225b511a6edec2891f7",
      "registration_number": "string",
      "admission_date": "2019-08-24",
      "dismissal_date": "2019-08-24",
      "records_start_date": "2019-08-24",
      "hour_rate_cents": 0,
      "department": "string",
      "job_role": "string",
      "allow_electronic_signature": true,
      "app_auto_approve": false,
      "web_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
    }
  }'

Responses

Novo funcionário criado com sucesso.

Bodyapplication/json
_idstring
_statusstring
Example: "OK"
_createdstring
Response
application/json
{
  "_id": "string",
  "_status": "OK",
  "_created": "string"
}

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.

Security
BasicAuth
Query
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?max_results=25&page=1'

Responses

Lista de funcionários.

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

Atualiza um funcionário

Request

Security
BasicAuth
Path
idstringrequired

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

Headers
If-Matchstringrequired

Para atualizar um documento é necessário o header com o valor do campo _etag atual do documento.

Bodyapplication/json
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_namestringrequired

Nome completo.

cpfstring^d{11}$

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

Example: 1234567890
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(?i)[0-9a-f]{24}\Z

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_dateany(date)

Data de nascimento.

citystringrequired

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

Example: "São Paulo"
statestringrequired

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"
send_app_linkboolean

Enviar por e-mail, no momento da criação, as instruções de uso do app mobile para o funcionário.

Default false
contract_dataobject
curl -i -X PATCH \
  -u <username>:<password> \
  'https://api-docs.tiquetaque.app/_mock/openapi/employees/{id}' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: string' \
  -d '{
    "external_id": "string",
    "full_name": "string",
    "cpf": 1234567890,
    "cnpj": 41443245000170,
    "nis": 12345678901,
    "mobile_phone": 11991234567,
    "work_schedule": "5ebee54eee1767f30129e61c",
    "phone_country_code": 55,
    "email": "exemplo@tiquetaque.com",
    "birth_date": null,
    "city": "São Paulo",
    "state": "SP",
    "timezone": "America/Sao_Paulo",
    "send_app_link": false,
    "contract_data": {
      "payment_source": "5ebee54eee1767f30129e61c",
      "manager": "5f5bc225b511a6edec2891f7",
      "registration_number": "string",
      "admission_date": "2019-08-24",
      "dismissal_date": "2019-08-24",
      "records_start_date": "2019-08-24",
      "hour_rate_cents": 0,
      "department": "string",
      "job_role": "string",
      "allow_electronic_signature": true,
      "app_auto_approve": false,
      "web_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
    }
  }'

Responses

Dados atualizados com sucesso.

Response
No 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-09T08:00-03:00"
_updatedstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example: "2024-09-09T08:00-03:00"
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: 1234567890
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(?i)[0-9a-f]{24}\Z

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_dateany(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"
send_app_linkboolean

Enviar por e-mail, no momento da criação, as instruções de uso do app mobile para o funcionário.

Default false
contract_dataobject
Response
application/json
{
  "_id": "string",
  "_created": "2024-09-09T08:00-03:00",
  "_updated": "2024-09-09T08:00-03:00",
  "external_id": "string",
  "full_name": "string",
  "cpf": 1234567890,
  "cnpj": 41443245000170,
  "nis": 12345678901,
  "mobile_phone": 11991234567,
  "work_schedule": "5ebee54eee1767f30129e61c",
  "phone_country_code": 55,
  "email": "exemplo@tiquetaque.com",
  "birth_date": null,
  "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,
    "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
  }
}

Exclui um funcionário

Request

Security
BasicAuth
Path
idstringrequired

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

Headers
If-Matchstringrequired

Para remover um documento é necessário o header com o valor do campo _etag atual do documento.

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

Responses

Cadastro excluído com sucesso.

Response
No content

Registros de ponto

Informações referentes aos registros de ponto.

Operations

Empregadores

Operações relacionadas aos empregadores.

Operations

Espelhos de ponto

Dados relativos à um período de espelho de ponto, como totais trabalhados, horas extras, banco de horas e afastamentos.

Operations

Unidades

Cadastros de unidades.

Operations

Usuários

Operações sobre os cadastros de usuários.

Operations