Toggl Track (Independent Publisher) (versão prévia)
O único software de acompanhamento de tempo que cria relatórios personalizados dos dados de tempo da sua equipe para maximizar a produtividade e a receita. Nossa solução de acompanhamento de tempo registra uma linha do tempo do calendário de todas as suas atividades de trabalho ao longo do dia.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | troystaylor |
| Site | https://toggl.com/track/automated-time-tracker/ |
| Política de privacidade | https://toggl.com/legal/track/privacy/ |
| Categorias | Produtividade |
Faixa de Agregação
O único software de acompanhamento de tempo que cria relatórios personalizados dos dados de tempo da sua equipe para maximizar a produtividade e a receita. Nossa solução de acompanhamento de tempo registra uma linha do tempo do calendário de todas as suas atividades de trabalho ao longo do dia.
Publicador: Troy Taylor, Hitachi Solutions
Pré-requisitos
Você deve se inscrever em uma conta com o Toggl.
Obtendo credenciais
Esse conector usa a autenticação básica com seu endereço de email e senha.
Operações com suporte
Obter o usuário atual
Retorna detalhes para o usuário atual.
Atualizar o usuário atual
Atualiza os detalhes do usuário atual.
Obter clientes de usuário
Obtenha clientes para o usuário atual.
Obter recursos do usuário
Obtenha recursos disponíveis para o usuário atual.
Obter a localização do usuário
Retorna o local baseado em IP do cliente. Se nenhum dado estiver presente, a resposta vazia será gerada.
Verificar autenticação
Usado para verificar se a autenticação funciona.
Obter organizações de usuários
Obtenha todas as organizações das quais um determinado usuário faz parte.
Obter projetos de usuário
Obtenha projetos para o usuário atual.
Obter projetos de usuário paginados
Obtenha projetos paginados para o usuário atual.
Obter marcas de usuário
Retorna marcas para o usuário atual.
Obter tarefas do usuário
Retorna tarefas de projetos nos quais o usuário está participando.
Obter lembretes de faixa
Retorna uma lista de lembretes de faixa.
Obter temporizador da Web
Obter a configuração do temporizador da Web.
Obter workspaces do usuário
Lista workspaces para determinado usuário.
Obter entradas de tempo
Lista as entradas de hora mais recentes.
Obter a entrada de hora atual
Carregar a entrada de tempo de execução para a ID do usuário.
Obter entrada de tempo por ID
Entrada de tempo de carga por ID acessível pelo usuário atual.
Obter usuários do workspace (nível da organização)
Retorna todos os usuários que pertencem ao workspace diretamente ou por meio de pelo menos um grupo.
Obter usuários do workspace
Liste todos os usuários para um determinado workspace.
Obter usuários do projeto do workspace
Listar todos os usuários de projetos para um determinado workspace.
Obter clientes de usuário
Obtenha clientes para o usuário atual.
Obter organizações de usuários
Obtenha todas as organizações das quais um determinado usuário faz parte.
Obter usuários do workspace (nível da organização)
Retorna todos os usuários que pertencem ao workspace diretamente ou por meio de pelo menos um grupo.
Obter projetos de usuário
Obtenha projetos para o usuário atual.
Obter projetos de usuário paginados
Obtenha projetos paginados para o usuário atual.
Obter usuários do projeto do workspace
Listar todos os usuários de projetos para um determinado workspace.
Obter projetos de workspace
Obtenha projetos para determinado workspace.
Obter projeto de workspace
Obtenha o projeto para determinado workspace.
Obter marcas de usuário
Retorna marcas para o usuário atual.
Obter tarefas do usuário
Retorna tarefas de projetos nos quais o usuário está participando.
Obter workspaces do usuário
Lista workspaces para determinado usuário.
Criar entrada de hora
Cria uma nova entrada de tempo do workspace.
Excluir entrada de hora
Exclui uma entrada de tempo do workspace.
Entrada de tempo de atualização
Atualiza uma entrada de tempo de workspace.
Entradas de tempo de edição em massa
Entradas de tempo de edição em massa. O patch será executado parcialmente quando houver erros com alguns registros. Nenhuma transação, nenhuma reversão.
Interrompa a entrada de hora
Interrompe uma entrada de tempo do workspace.
Obter usuários do workspace (nível da organização)
Retorna todos os usuários que pertencem ao workspace diretamente ou por meio de pelo menos um grupo.
Obter um único workspace
Obter informações de um único workspace.
Obter lista de taxas
Obter taxas por nível (workspace|project|task|user).
Obter estatísticas do workspace
Retorna a lista de administradores do workspace, contagem de membros e contagem de grupos.
Obter restrições de entrada de tempo do workspace
Obtenha as restrições de entrada de tempo para um determinado workspace.
Obter lembretes de faixa de workspace
Retorna uma lista de lembretes de faixa.
Obter usuários do workspace
Liste todos os usuários para um determinado workspace.
Obter usuários do projeto do workspace
Listar todos os usuários de projetos para um determinado workspace.
Obter projetos de workspace
Obtenha projetos para determinado workspace.
Obter projeto de workspace
Obtenha o projeto para determinado workspace.
Obter entradas de tempo
Lista as entradas de hora mais recentes.
Obter a entrada de hora atual
Carregar a entrada de tempo de execução para a ID do usuário.
Obter entrada de tempo por ID
Entrada de tempo de carga por ID acessível pelo usuário atual.
Quando uma entrada de hora é criada
Dispara quando uma nova entrada de hora é criada no workspace.
Quando uma entrada de hora é atualizada
Dispara quando uma entrada de tempo existente é modificada no workspace.
Quando uma entrada de hora é excluída
Dispara quando uma entrada de hora é excluída do workspace.
Quando uma entrada de hora é iniciada
Dispara quando uma entrada de hora é iniciada (o temporizador começa) no workspace.
Quando uma entrada de hora é interrompida
Dispara quando uma entrada de tempo de execução é interrompida no workspace.
Problemas e limitações conhecidos
Não há problemas conhecidos no momento.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome de usuário | secureString | O nome de usuário para esta api | Verdade |
| Senha | secureString | A senha dessa api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar o usuário atual |
Atualiza os detalhes do usuário atual. |
| Criar entrada de hora |
Cria um novo TimeEntry do workspace. |
| Entrada de tempo de atualização |
Atualiza uma entrada de tempo de workspace. |
| Entradas de tempo de edição em massa |
Entradas de tempo de edição em massa. O patch será executado parcialmente quando houver erros com alguns registros. Nenhuma transação, nenhuma reversão. |
| Excluir entrada de hora |
Exclui uma entrada de tempo do workspace. |
| Interrompa a entrada de hora |
Interrompe uma entrada de tempo do workspace. |
| Obter a entrada de hora atual |
Carregar a entrada de tempo de execução para a ID do usuário. |
| Obter a localização do usuário |
Retorna o local baseado em IP do cliente. Se nenhum dado estiver presente, a resposta vazia será gerada. |
| Obter clientes de usuário |
Obtenha clientes para o usuário atual. |
| Obter entrada de tempo por ID |
Entrada de tempo de carga por ID acessível pelo usuário atual. |
| Obter entradas de tempo |
Lista as entradas de hora mais recentes. |
| Obter estatísticas do workspace |
Retorna a lista de administradores do workspace, contagem de membros e contagem de grupos. |
| Obter lembretes de faixa |
Retorna uma lista de lembretes de faixa. |
| Obter lembretes de faixa de workspace |
Retorna uma lista de lembretes de faixa. |
| Obter lista de taxas |
Obter taxas por nível (workspace|project|task|user). |
| Obter marcas de usuário |
Retorna marcas para o usuário atual. |
| Obter o usuário atual |
Retorna detalhes para o usuário atual. |
| Obter organizações de usuários |
Obtenha todas as organizações das quais um determinado usuário faz parte. |
| Obter projeto de workspace |
Obtenha o projeto para determinado workspace. |
| Obter projetos de usuário |
Obtenha projetos para o usuário atual. |
| Obter projetos de usuário paginados |
Obtenha projetos paginados para o usuário atual. |
| Obter projetos de workspace |
Obtenha projetos para determinado workspace. |
| Obter recursos do usuário |
Obtenha recursos disponíveis para o usuário atual. |
| Obter restrições de entrada de tempo do workspace |
Obtenha as restrições de entrada de tempo para um determinado workspace. |
| Obter tarefas do usuário |
Retorna tarefas de projetos nos quais o usuário está participando. |
| Obter temporizador da Web |
Obter a configuração do temporizador da Web. |
| Obter um único workspace |
Obter informações de um único workspace. |
| Obter usuários do projeto do workspace |
Listar todos os usuários de projetos para um determinado workspace. |
| Obter usuários do workspace |
Liste todos os usuários para um determinado workspace. |
| Obter usuários do workspace (nível da organização) |
Retorna todos os usuários que pertencem ao workspace diretamente ou por meio de pelo menos um grupo. |
| Obter workspaces do usuário |
Lista workspaces para determinado usuário. |
| Verificar autenticação |
Usado para verificar se a autenticação funciona. |
Atualizar o usuário atual
Atualiza os detalhes do usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Início da Semana
|
beginning_of_week | integer |
O primeiro dia da semana do usuário. Domingo: 0, segunda-feira: 1, etc. |
|
|
ID do país
|
country_id | integer |
ID do país do usuário. |
|
|
Senha atual
|
current_password | string |
Senha atual do usuário (usada para alterar a senha atual). |
|
|
ID do workspace padrão
|
default_workspace_id | integer |
ID do workspace padrão do usuário. |
|
|
Email
|
string |
Endereço de email do usuário. |
||
|
Nome Completo
|
fullname | string |
Nome completo do usuário. |
|
|
Nova senha
|
password | string |
A nova senha do usuário (a atual também deve ser fornecida). |
|
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
Retornos
- Corpo
- UserBasicResponse
Criar entrada de hora
Cria um novo TimeEntry do workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Incluir Metadados
|
meta | boolean |
Se a resposta contiver dados para meta entidades. |
|
|
Faturável
|
billable | boolean |
Se a entrada de hora é marcada como faturável, opcional, falso padrão. |
|
|
Criado com
|
created_with | string |
Deve ser fornecido ao criar uma entrada de tempo e deve identificar o serviço/aplicativo usado para criá-lo. |
|
|
Description
|
description | string |
Descrição da entrada de hora, opcional. |
|
|
Duração
|
duration | integer |
Duração da entrada de tempo. Para executar entradas deve ser negativo, preferível -1. |
|
|
Somente duração
|
duronly | boolean |
Preterido: usado para criar uma entrada de tempo com uma duração, mas sem um tempo de parada. Esse parâmetro pode ser ignorado. |
|
|
Recurso de origem
|
origin_feature | string |
Nome do recurso de origem. |
|
|
Contagem de metas visíveis
|
visible_goals_count | integer |
Número de metas visíveis. |
|
|
IDs de despesas
|
expense_ids | array of integer |
Despesas de Trabalho associadas à Entrada de Tempo. |
|
|
ID do projeto (herdado)
|
pid | integer |
ID do projeto, campo herdado. |
|
|
ID do projeto
|
project_id | integer |
ID do projeto, opcional. |
|
|
Compartilhado com IDs de Usuário
|
shared_with_user_ids | array of integer |
Lista de IDs de usuário com as quais compartilhar essa entrada de hora. |
|
|
Hora de Início
|
start | string |
Hora de início em UTC, necessária para a criação. Formato: 2006-01-02T15:04:05Z. |
|
|
Data de Início
|
start_date | string |
Se for fornecida durante a criação, a parte de data terá precedência sobre a parte de data de 'start'. Formato: 2006-11-07. |
|
|
Tempo de Parada
|
stop | string |
Parar o tempo em UTC, poderá ser omitido se ele ainda estiver em execução ou criado com "duração". Se 'stop' e 'duration' forem fornecidos, os valores deverão ser consistentes (start + duration == stop). |
|
|
Ação de marcação
|
tag_action | string |
Pode ser "adicionar" ou "excluir". Usado ao atualizar uma entrada de tempo existente. |
|
|
IDs de marca
|
tag_ids | array of integer |
IDs de marcas a serem adicionadas/removidas. |
|
|
Etiquetas
|
tags | array of string |
Nomes de marcas a serem adicionadas/removidas. Se o nome não existir como marca, um será criado automaticamente. |
|
|
ID da Tarefa
|
task_id | integer |
ID da tarefa, opcional. |
|
|
ID da tarefa (herdada)
|
tid | integer |
ID da tarefa, campo herdado. |
|
|
ID do usuário (herdado)
|
uid | integer |
ID do criador do Time Entry, campo herdado. |
|
|
ID do Usuário
|
user_id | integer |
ID do criador do Time Entry, se omitida, usará a ID do usuário solicitante. |
|
|
ID do workspace (herdado)
|
wid | integer |
ID do workspace, campo herdado. |
|
|
ID do workspace
|
workspace_id | integer |
ID do workspace, necessária. |
Retornos
- Corpo
- TimeEntry
Entrada de tempo de atualização
Atualiza uma entrada de tempo de workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
ID da entrada de hora
|
time_entry_id | True | integer |
ID do TimeEntry. |
|
Incluir Metadados
|
meta | boolean |
Se a resposta contiver dados para meta entidades. |
|
|
Incluir compartilhamento
|
include_sharing | boolean |
Inclua detalhes de compartilhamento na resposta. |
|
|
Faturável
|
billable | boolean |
Se a entrada de hora é marcada como faturável, opcional, falso padrão. |
|
|
Criado com
|
created_with | string |
Deve ser fornecido ao criar uma entrada de tempo e deve identificar o serviço/aplicativo usado para criá-lo. |
|
|
Description
|
description | string |
Descrição da entrada de hora, opcional. |
|
|
Duração
|
duration | integer |
Duração da entrada de tempo. Para executar entradas deve ser negativo, preferível -1. |
|
|
Somente duração
|
duronly | boolean |
Preterido: usado para criar uma entrada de tempo com uma duração, mas sem um tempo de parada. Esse parâmetro pode ser ignorado. |
|
|
Recurso de origem
|
origin_feature | string |
Nome do recurso de origem. |
|
|
Contagem de metas visíveis
|
visible_goals_count | integer |
Número de metas visíveis. |
|
|
IDs de despesas
|
expense_ids | array of integer |
Despesas de Trabalho associadas à Entrada de Tempo. |
|
|
ID do projeto (herdado)
|
pid | integer |
ID do projeto, campo herdado. |
|
|
ID do projeto
|
project_id | integer |
ID do projeto, opcional. |
|
|
Compartilhado com IDs de Usuário
|
shared_with_user_ids | array of integer |
Lista de IDs de usuário com as quais compartilhar essa entrada de hora. |
|
|
Hora de Início
|
start | string |
Hora de início em UTC, necessária para a criação. Formato: 2006-01-02T15:04:05Z. |
|
|
Data de Início
|
start_date | string |
Se for fornecida durante a criação, a parte de data terá precedência sobre a parte de data de 'start'. Formato: 2006-11-07. |
|
|
Tempo de Parada
|
stop | string |
Parar o tempo em UTC, poderá ser omitido se ele ainda estiver em execução ou criado com "duração". Se 'stop' e 'duration' forem fornecidos, os valores deverão ser consistentes (start + duration == stop). |
|
|
Ação de marcação
|
tag_action | string |
Pode ser "adicionar" ou "excluir". Usado ao atualizar uma entrada de tempo existente. |
|
|
IDs de marca
|
tag_ids | array of integer |
IDs de marcas a serem adicionadas/removidas. |
|
|
Etiquetas
|
tags | array of string |
Nomes de marcas a serem adicionadas/removidas. Se o nome não existir como marca, um será criado automaticamente. |
|
|
ID da Tarefa
|
task_id | integer |
ID da tarefa, opcional. |
|
|
ID da tarefa (herdada)
|
tid | integer |
ID da tarefa, campo herdado. |
|
|
ID do usuário (herdado)
|
uid | integer |
ID do criador do Time Entry, campo herdado. |
|
|
ID do Usuário
|
user_id | integer |
ID do criador do Time Entry, se omitida, usará a ID do usuário solicitante. |
|
|
ID do workspace (herdado)
|
wid | integer |
ID do workspace, campo herdado. |
|
|
ID do workspace
|
workspace_id | integer |
ID do workspace, necessária. |
Retornos
- Corpo
- TimeEntry
Entradas de tempo de edição em massa
Entradas de tempo de edição em massa. O patch será executado parcialmente quando houver erros com alguns registros. Nenhuma transação, nenhuma reversão.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
IDs de entrada de tempo
|
time_entry_ids | True | string |
IDs numéricas de time_entries, separadas por vírgula. Por exemplo: 204301830,202700150,202687559. O limite é de 100 IDs por solicitação. |
|
Incluir Metadados
|
meta | boolean |
Se a resposta contiver dados para meta entidades. |
|
|
Operation
|
op | True | string |
Operação (adicionar/remover/substituir). |
|
Caminho
|
path | True | string |
O caminho para a entidade a ser corrigida (por exemplo, /description). |
|
Value
|
value | object |
O novo valor da entidade no caminho. |
Retornos
- Corpo
- BulkEditResponse
Excluir entrada de hora
Exclui uma entrada de tempo do workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
ID da entrada de hora
|
time_entry_id | True | integer |
ID do TimeEntry. |
Interrompa a entrada de hora
Interrompe uma entrada de tempo do workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
ID da entrada de hora
|
time_entry_id | True | integer |
ID do TimeEntry. |
Retornos
- Corpo
- TimeEntry
Obter a entrada de hora atual
Obter a localização do usuário
Retorna o local baseado em IP do cliente. Se nenhum dado estiver presente, a resposta vazia será gerada.
Retornos
- Corpo
- LocationResponse
Obter clientes de usuário
Obtenha clientes para o usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
Retornos
- response
- array of Client
Obter entrada de tempo por ID
Entrada de tempo de carga por ID acessível pelo usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da entrada de hora
|
time_entry_id | True | integer |
ID do TimeEntry. |
|
Incluir Metadados
|
meta | boolean |
Se a resposta contiver dados para meta entidades. |
|
|
Incluir compartilhamento
|
include_sharing | boolean |
Inclua detalhes de compartilhamento na resposta. |
Retornos
- Corpo
- TimeEntry
Obter entradas de tempo
Lista as entradas de hora mais recentes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir Metadados
|
meta | boolean |
Se a resposta contiver dados para meta entidades. |
|
|
Incluir compartilhamento
|
include_sharing | boolean |
Inclua detalhes de compartilhamento na resposta. |
|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
|
|
Data anterior
|
before | string |
Obtenha entradas com a hora de início, antes da data fornecida (YYYY-MM-DD) ou com a hora em RFC3339 formato. |
|
|
Data de Início
|
start_date | string |
Obtenha entradas com a hora de início, de start_date YYYY-MM-DD ou com o tempo no formato RFC3339. Para ser usado com end_date. |
|
|
Data de Término
|
end_date | string |
Obtenha entradas com a hora de início, até end_date YYYY-MM-DD ou com o tempo em RFC3339 formato. Para ser usado com start_date. |
Retornos
- response
- array of TimeEntry
Obter estatísticas do workspace
Retorna a lista de administradores do workspace, contagem de membros e contagem de grupos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
Retornos
- Corpo
- WorkspaceStatistics
Obter lembretes de faixa
Obter lembretes de faixa de workspace
Retorna uma lista de lembretes de faixa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
Retornos
- Corpo
- TrackRemindersResponse
Obter lista de taxas
Obter taxas por nível (workspace|project|task|user).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Level
|
level | True | string |
Nível de taxas: workspace, projeto, tarefa ou usuário. |
|
ID de nível
|
level_id | True | integer |
ID numérica do nível de entidade. |
|
Tipo de taxa
|
type | string |
Tipo de valores de taxa a serem retornados: billable_rates ou labor_costs. O padrão é billable_rates. |
Retornos
- response
- array of Rate
Obter marcas de usuário
Retorna marcas para o usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
Retornos
- response
- array of Tag
Obter o usuário atual
Retorna detalhes para o usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir dados relacionados
|
with_related_data | boolean |
Recupere dados relacionados ao usuário (clientes, projetos, tarefas, marcas, workspaces, entradas de tempo etc.). |
Retornos
- Corpo
- UserResponse
Obter organizações de usuários
Obtenha todas as organizações das quais um determinado usuário faz parte.
Retornos
- response
- array of Organization
Obter projeto de workspace
Obtenha o projeto para determinado workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
ID do projeto
|
project_id | True | integer |
ID numérica do projeto. |
Retornos
- Corpo
- Project
Obter projetos de usuário
Obtenha projetos para o usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir arquivado
|
include_archived | string |
Inclua projetos arquivados. |
|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
Retornos
- response
- array of Project
Obter projetos de usuário paginados
Obtenha projetos paginados para o usuário atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Iniciar id do projeto
|
start_project_id | integer |
ID do projeto da qual será retomada a próxima paginação. |
|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
Retornos
- response
- array of Project
Obter projetos de workspace
Obtenha projetos para determinado workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Classificar fixado
|
sort_pinned | True | boolean |
Coloque projetos fixados na parte superior da resposta. |
|
Somente usuários ativos
|
active | boolean |
Retorna somente usuários ativos. |
|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
|
|
Faturável
|
billable | boolean |
Filtrar por status faturável. |
|
|
IDs de usuário
|
user_ids | array |
IDs de usuário pelas quais filtrar. |
|
|
IDs do cliente
|
client_ids | array |
IDs do cliente para filtrar. |
|
|
IDs de grupo
|
group_ids | array |
Agrupar IDs para filtrar. |
|
|
IDs do projeto
|
project_ids | string |
IDs numéricas de projetos, separados por vírgulas. |
|
|
Estados
|
statuses | array |
Status do projeto pelo qual filtrar. |
|
|
Filtro de nome
|
name | string |
Nome de usuário do workspace pelo qual filtrar. |
|
|
Número da Página
|
page | integer |
Número da página. |
|
|
Campo classificar
|
sort_field | True | string |
Campo pelo qual ordenar. |
|
Ordem de Classificação
|
sort_order | True | string |
Ordem de classificação (asc/desc). |
|
Somente modelos
|
only_templates | True | boolean |
Retornar somente modelos de projeto. |
|
Somente Meus Projetos
|
only_me | boolean |
Obtenha somente projetos atribuídos ao usuário atual. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
Retornos
- response
- array of Project
Obter recursos do usuário
Obter restrições de entrada de tempo do workspace
Obtenha as restrições de entrada de tempo para um determinado workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
Retornos
- Corpo
- TimeEntryConstraints
Obter tarefas do usuário
Retorna tarefas de projetos nos quais o usuário está participando.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Incluir Metadados
|
meta | boolean |
Se a resposta contiver dados para meta entidades. |
|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
|
|
Incluir tarefas inativas
|
include_not_active | string |
Inclua tarefas marcadas como concluídas. |
|
|
Deslocamento de paginação
|
offset | integer |
Deslocamento para retomar a próxima paginação. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
Retornos
- response
- array of Task
Obter temporizador da Web
Obter a configuração do temporizador da Web.
Obter um único workspace
Obter informações de um único workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
Retornos
- Corpo
- Workspace
Obter usuários do projeto do workspace
Listar todos os usuários de projetos para um determinado workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
IDs do projeto
|
project_ids | string |
IDs numéricas de projetos, separados por vírgulas. |
|
|
ID do Usuário
|
user_id | string |
A ID numérica do usuário, se aprovada, retorna apenas os usuários do projeto para os projetos desse usuário. |
|
|
Incluir membros do grupo
|
with_group_members | boolean |
Inclua membros do grupo. |
Retornos
- response
- array of ProjectUser
Obter usuários do workspace
Liste todos os usuários para um determinado workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Excluir Excluído
|
exclude_deleted | boolean |
Exclua registros excluídos na resposta. |
Retornos
- response
- array of WorkspaceUserSimple
Obter usuários do workspace (nível da organização)
Retorna todos os usuários que pertencem ao workspace diretamente ou por meio de pelo menos um grupo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organization_id | True | integer |
ID numérica da organização. |
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Número da Página
|
page | integer |
Número da página. |
|
|
Itens por página
|
per_page | integer |
Número de itens por página, padrão 201. |
|
|
Filtro de Taxas Personalizadas
|
custom_rates | boolean |
Retorna somente usuários com ou sem uma taxa por hora personalizada, respectivamente. |
|
|
Somente usuários ativos
|
active | boolean |
Retorna somente usuários ativos. |
|
|
Filtro de nome
|
name | string |
Nome de usuário do workspace pelo qual filtrar. |
|
|
Filtro de Pesquisa
|
search | string |
Filtro de workspace por nome ou email. |
Retornos
- response
- array of WorkspaceUser
Obter workspaces do usuário
Lista workspaces para determinado usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Desde a Data
|
since | integer |
Recupere itens criados/modificados/excluídos desde esta data usando o carimbo de data/hora UNIX. |
Retornos
- response
- array of Workspace
Verificar autenticação
Usado para verificar se a autenticação funciona.
Gatilhos
| Quando uma entrada de hora é atualizada |
Dispara quando uma entrada de tempo existente é modificada no workspace. |
| Quando uma entrada de hora é criada |
Dispara quando uma nova entrada de hora é criada no workspace. |
| Quando uma entrada de hora é excluída |
Dispara quando uma entrada de hora é excluída do workspace. |
| Quando uma entrada de hora é iniciada |
Dispara quando uma entrada de hora é iniciada (o temporizador começa) no workspace. |
| Quando uma entrada de hora é interrompida |
Dispara quando uma entrada de tempo de execução é interrompida no workspace. |
Quando uma entrada de hora é atualizada
Dispara quando uma entrada de tempo existente é modificada no workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Entidade
|
entity | string |
Entidade de negócios Toggl Track a ser filtrada. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Retornos
- Corpo
- TimeEntryWebhookEvent
Quando uma entrada de hora é criada
Dispara quando uma nova entrada de hora é criada no workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Entidade
|
entity | string |
Entidade de negócios Toggl Track a ser filtrada. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Retornos
- Corpo
- TimeEntryWebhookEvent
Quando uma entrada de hora é excluída
Dispara quando uma entrada de hora é excluída do workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Entidade
|
entity | string |
Entidade de negócios Toggl Track a ser filtrada. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Retornos
- Corpo
- TimeEntryWebhookEvent
Quando uma entrada de hora é iniciada
Dispara quando uma entrada de hora é iniciada (o temporizador começa) no workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Entidade
|
entity | string |
Entidade de negócios Toggl Track a ser filtrada. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Retornos
- Corpo
- TimeEntryWebhookEvent
Quando uma entrada de hora é interrompida
Dispara quando uma entrada de tempo de execução é interrompida no workspace.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do workspace
|
workspace_id | True | integer |
ID numérica do workspace. |
|
Entidade
|
entity | string |
Entidade de negócios Toggl Track a ser filtrada. |
|
|
Ação
|
action | string |
Tipo de modificação aplicada à entidade. |
Retornos
- Corpo
- TimeEntryWebhookEvent
Definições
UserResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
2FA Habilitada
|
2fa_enabled | boolean |
Status habilitado para autenticação de dois fatores. |
|
Token API
|
api_token | string |
O token de API será omitido se estiver vazio. |
|
Última Atualização
|
at | string |
Carimbo de data/hora da última atualização. |
|
Autorização atualizada
|
authorization_updated_at | string |
Carimbo de data/hora quando o objeto de sessão do usuário de autorização foi atualizado pela última vez. |
|
Início da Semana
|
beginning_of_week | integer |
O primeiro dia da semana do usuário (0=domingo, 1=segunda-feira, etc.). |
|
Clients
|
clients | array of Client |
Clientes, nulos se with_related_data não foi definido como true. |
|
ID do país
|
country_id | integer |
ID do país do usuário. |
|
Criado em
|
created_at | string |
Carimbo de data/hora de criação do usuário. |
|
ID do workspace padrão
|
default_workspace_id | integer |
ID do workspace padrão do usuário. |
|
Email
|
string |
Endereço de email do usuário. |
|
|
Nome Completo
|
fullname | string |
Nome completo do usuário. |
|
Tem senha
|
has_password | boolean |
Se o usuário tem um conjunto de senhas. |
|
ID do Usuário
|
id | integer |
ID de usuário. |
|
URL da imagem
|
image_url | string |
URL da imagem de perfil do usuário. |
|
Hash de interfone
|
intercom_hash | string |
O hash de interfone será omitido se estiver vazio. |
|
Provedores OAuth
|
oauth_providers | array of string |
Provedores OAuth disponíveis para o usuário. |
|
OpenID Email
|
openid_email | string |
Endereço de email OpenID. |
|
OpenID Habilitado
|
openid_enabled | boolean |
Status habilitado para autenticação OpenID. |
|
Opções
|
options | object |
As opções do usuário serão omitidas se estiverem vazias. |
|
Projetos
|
projects | array of Project |
Projetos, nulos se with_related_data não foi definido como true. |
|
Etiquetas
|
tags | array of Tag |
Marcas, nulas se with_related_data não foi definida como true. |
|
Tasks
|
tasks | array of Task |
Tarefas, nulas se with_related_data não foi definido como true. |
|
Entradas de tempo
|
time_entries | array of TimeEntry |
Entradas de tempo, nulas se with_related_data não foi definida como true. |
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
|
Atualizado em
|
updated_at | string |
Carimbo de data/hora da última atualização do usuário. |
|
Workspaces
|
workspaces | array of Workspace |
Workspaces, null se with_related_data não foi definido como true. |
UserBasicResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
2FA Habilitada
|
2fa_enabled | boolean |
Status habilitado para autenticação de dois fatores. |
|
Token API
|
api_token | string |
O token de API será omitido se estiver vazio. |
|
Última Atualização
|
at | string |
Carimbo de data/hora da última atualização. |
|
Início da Semana
|
beginning_of_week | integer |
O primeiro dia da semana do usuário. |
|
ID do país
|
country_id | integer |
ID do país do usuário. |
|
Criado em
|
created_at | string |
Carimbo de data/hora de criação do usuário. |
|
ID do workspace padrão
|
default_workspace_id | integer |
ID do workspace padrão do usuário. |
|
Email
|
string |
Endereço de email do usuário. |
|
|
Nome Completo
|
fullname | string |
Nome completo do usuário. |
|
Tem senha
|
has_password | boolean |
Se o usuário tem um conjunto de senhas. |
|
ID do Usuário
|
id | integer |
ID de usuário. |
|
URL da imagem
|
image_url | string |
URL da imagem de perfil do usuário. |
|
OpenID Email
|
openid_email | string |
Endereço de email OpenID. |
|
OpenID Habilitado
|
openid_enabled | boolean |
Status habilitado para autenticação OpenID. |
|
Opções
|
options | object |
As opções do usuário serão omitidas se estiverem vazias. |
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
|
Atualizado em
|
updated_at | string |
Carimbo de data/hora da última atualização do usuário. |
Cliente
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Arquivados
|
archived | boolean |
Será true se o cliente for arquivado. |
|
Última Atualização
|
at | string |
Quando foi a última atualização. |
|
ID do Criador
|
creator_id | integer |
ID do usuário que criou o cliente. |
|
Referência externa
|
external_reference | string |
Referência externa à entidade Track Client. |
|
ID do cliente
|
id | integer |
ID do Cliente. |
|
ID externa de integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo externo de integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade toggl Track. |
|
Nome do cliente
|
name | string |
Nome do cliente. |
|
Anotações
|
notes | string |
Notas do cliente. |
|
Permissions
|
permissions | array of string |
Lista de permissões de autorização para esse cliente. |
|
Contagem total
|
total_count | integer |
Campo total para armazenar a contagem total. |
|
ID do workspace
|
wid | integer |
ID do workspace. |
Projeto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
Se o projeto está ativo ou arquivado. |
|
Horas reais
|
actual_hours | integer |
Horas reais gastas no projeto. |
|
Segundos reais
|
actual_seconds | integer |
Segundos reais gastos no projeto. |
|
Última Atualização
|
at | string |
Data da última atualização. |
|
Estimativas Automáticas
|
auto_estimates | boolean |
Estimativas automáticas habilitadas. |
|
Faturável
|
billable | boolean |
Se o projeto é faturável. |
|
Pode acompanhar o tempo
|
can_track_time | boolean |
Se o tempo pode ser acompanhado para este projeto. |
|
ID do cliente (herdado)
|
cid | integer |
Campo herdado da ID do cliente. |
|
ID do cliente
|
client_id | integer |
ID do Cliente. |
|
Nome do cliente
|
client_name | string |
Nome do cliente. |
|
Cor
|
color | string |
Cor do projeto. |
|
Criado em
|
created_at | string |
Data de criação. |
|
Moeda
|
currency | string |
Moeda do projeto. |
|
Período Atual
|
current_period | object |
Período de projeto atual, recurso premium. |
|
Data de Término
|
end_date | string |
Data de término do projeto. |
|
Horas Estimadas
|
estimated_hours | integer |
Horas estimadas para o projeto. |
|
Segundos Estimados
|
estimated_seconds | integer |
Segundos estimados para o projeto. |
|
Referência externa
|
external_reference | string |
Referência externa à Entidade de Rastreamento do Projeto. |
|
Taxa Fixa
|
fixed_fee | double |
Taxa fixa, recurso Premium. |
|
ID do projeto
|
id | integer |
ID do projeto. |
|
ID externa de integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo externo de integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade toggl Track. |
|
É privado
|
is_private | boolean |
Se o projeto é privado. |
|
Nome do Projeto
|
name | string |
Nome do projeto. |
|
Permissions
|
permissions | array of string |
Permissões de projeto. |
|
Pinned
|
pinned | boolean |
Se o projeto está fixado. |
|
Taxa por Hora
|
rate | double |
Taxa por hora para o projeto. |
|
Taxa Última Atualização
|
rate_last_updated | string |
Quando a taxa foi atualizada pela última vez. |
|
Recorrente
|
recurring | boolean |
Se o projeto é recorrente, o recurso premium. |
|
Parâmetros recorrentes
|
recurring_parameters | array of RecurringParameter |
Parâmetros recorrentes do projeto, recurso Premium. |
|
Data de Início
|
start_date | string |
Data de início do projeto. |
|
Situação
|
status | string |
Status do projeto (próximo, ativo, encerrado, arquivado, excluído). |
|
Template
|
template | boolean |
Se o projeto é um modelo. |
|
ID do Modelo
|
template_id | integer |
ID do modelo se o projeto for baseado no modelo. |
|
Contagem total
|
total_count | integer |
Número total de projetos encontrados. |
|
ID do workspace (herdado)
|
wid | integer |
Campo herdado da ID do workspace. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace. |
RecurringParameter
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Período Personalizado
|
custom_period | integer |
Período personalizado, usado quando o campo de período é 'personalizado'. |
|
Segundos Estimados
|
estimated_seconds | integer |
Segundos estimados. |
|
Data de término do parâmetro
|
parameter_end_date | string |
Data de término do parâmetro. |
|
Data de início do parâmetro
|
parameter_start_date | string |
Data de início recorrente. |
|
Período
|
period | string |
Período recorrente. |
|
Data de início do projeto
|
project_start_date | string |
Data de início do projeto. |
Etiqueta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Última modificação
|
at | string |
Quando foi criado/modificado pela última vez. |
|
ID do Criador
|
creator_id | integer |
ID do usuário que criou a marca. |
|
Excluído em
|
deleted_at | string |
Quando foi excluído. |
|
ID da marca
|
id | integer |
ID da marca. |
|
ID externa de integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo externo de integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade toggl Track. |
|
Nome da Marca
|
name | string |
Nome da marca. |
|
Permissions
|
permissions | array of string |
Permissões de marcação. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace. |
Tarefa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
False quando a tarefa tiver sido feita. |
|
Última modificação
|
at | string |
Quando a tarefa foi criada/modificada pela última vez. |
|
Avatar URL
|
avatar_url | string |
URL do Avatar. |
|
Nome do cliente
|
client_name | string |
Nome do cliente. |
|
Segundos Estimados
|
estimated_seconds | integer |
Segundos estimados para a tarefa. |
|
ID da Tarefa
|
id | integer |
ID da tarefa. |
|
ID externa de integração
|
integration_ext_id | string |
ID externa da entidade vinculada no sistema externo. |
|
Tipo externo de integração
|
integration_ext_type | string |
Tipo externo da entidade vinculada no sistema externo. |
|
Provedor de Integração
|
integration_provider | object |
Provedor que tem uma entidade vinculada a essa entidade toggl Track. |
|
Nome da tarefa
|
name | string |
Nome da tarefa. |
|
Permissions
|
permissions | array of string |
Permissões de tarefa. |
|
Projeto faturável
|
project_billable | boolean |
Se o projeto é faturável. |
|
Cor do Projeto
|
project_color | string |
Metadados de cor do projeto. |
|
ID do projeto
|
project_id | integer |
ID do projeto. |
|
O projeto é privado
|
project_is_private | boolean |
Se o projeto é privado. |
|
Nome do Projeto
|
project_name | string |
Nome do projeto. |
|
Rate
|
rate | double |
Taxa para esta tarefa. |
|
Taxa Última Atualização
|
rate_last_updated | string |
Quando a taxa foi atualizada pela última vez. |
|
Recorrente
|
recurring | boolean |
Se essa é uma tarefa recorrente. |
|
ID de Contas de Agregação
|
toggl_accounts_id | string |
ID de contas de agregação. |
|
Segundos rastreados
|
tracked_seconds | integer |
O valor tracked_seconds está em milissegundos, não em segundos. |
|
ID do Usuário
|
user_id | integer |
ID de usuário. |
|
Nome do usuário
|
user_name | string |
Nome de utilizador. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace. |
TimeEntry
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Última Atualização
|
at | string |
Quando foi atualizado pela última vez, segue o formato ISO 8601. |
|
Faturável
|
billable | boolean |
Se a entrada de hora é marcada como faturável. |
|
Nome do cliente
|
client_name | string |
Meta campos de entidades relacionadas. |
|
Description
|
description | string |
Descrição da entrada de hora. |
|
Duração
|
duration | integer |
Duração da entrada de tempo. Para executar entradas deve ser negativo, preferível -1. |
|
Somente duração
|
duronly | boolean |
Usado para criar uma TE com uma duração, mas sem tempo de parada. |
|
IDs de despesas
|
expense_ids | array of integer |
Despesas de trabalho. |
|
ID da entrada de hora
|
id | integer |
ID da entrada de hora. |
|
Permissions
|
permissions | array of string |
Lista de permissões. |
|
ID do projeto (herdado)
|
pid | integer |
ID do projeto, campo herdado. |
|
Project Active
|
project_active | boolean |
Se o projeto está ativo. |
|
Projeto faturável
|
project_billable | boolean |
Se o projeto é faturável. |
|
Cor do Projeto
|
project_color | string |
Cor do projeto. |
|
ID do projeto
|
project_id | integer |
ID do projeto. |
|
Nome do Projeto
|
project_name | string |
Nome do projeto. |
|
Compartilhado com
|
shared_with | array of SharedWith |
Indica com quem a entrada de tempo foi compartilhada. |
|
Hora de Início
|
start | string |
Hora de início em UTC. |
|
Tempo de Parada
|
stop | string |
O tempo de parada em UTC poderá ser nulo se ele ainda estiver em execução. |
|
IDs de marca
|
tag_ids | array of integer |
IDs de marca, nulas se as marcas não foram fornecidas ou foram excluídas posteriormente. |
|
Etiquetas
|
tags | array of string |
Nomes de marca, nulos se as marcas não foram fornecidas ou posteriormente excluídas. |
|
ID da Tarefa
|
task_id | integer |
ID da tarefa. |
|
Nome da tarefa
|
task_name | string |
Nome da tarefa. |
|
ID da tarefa (herdada)
|
tid | integer |
ID da tarefa, campo herdado. |
|
ID do usuário (herdado)
|
uid | integer |
ID do criador do Time Entry, campo herdado. |
|
URL do Avatar do Usuário
|
user_avatar_url | string |
URL do avatar do usuário. |
|
ID do Usuário
|
user_id | integer |
ID do criador do Time Entry. |
|
Nome do usuário
|
user_name | string |
Nome de utilizador. |
|
ID do workspace (herdado)
|
wid | integer |
ID do workspace, campo herdado. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace. |
SharedWith
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Aceitado
|
accepted | boolean |
Se a ação foi aceita. |
|
ID do Usuário
|
user_id | integer |
ID de usuário de pessoa compartilhada. |
|
Nome do usuário
|
user_name | string |
Nome de usuário da pessoa compartilhada. |
Workspace
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de projetos ativos
|
active_project_count | integer |
Número de projetos ativos. |
|
Admin
|
admin | boolean |
O usuário atual é o administrador do workspace (preterido). |
|
Token API
|
api_token | string |
Token de API (preterido). |
|
Última Alteração
|
at | string |
Carimbo de data/hora da última alteração do workspace. |
|
Workspace de negócios
|
business_ws | boolean |
Workspace na assinatura Premium. |
|
CSV Upload
|
csv_upload | object |
Dados de upload do CSV. |
|
Moeda Padrão
|
default_currency | string |
Moeda padrão, recurso Premium. |
|
Taxa por hora padrão
|
default_hourly_rate | double |
A taxa por hora padrão, o recurso Premium. |
|
Desabilitar aprovações
|
disable_approvals | boolean |
Desabilite as aprovações no workspace. |
|
Desabilitar Exibição de Quadro de Horários
|
disable_timesheet_view | boolean |
Desabilite o modo de exibição de quadro de horários no workspace. |
|
Ocultar Horários de Término de Início
|
hide_start_end_times | boolean |
Ocultar horários de início e término. |
|
iCal Habilitado
|
ical_enabled | boolean |
Integração de calendário habilitada. |
|
URL do iCal
|
ical_url | string |
URL do calendário. |
|
ID do workspace
|
id | integer |
Identificador do workspace. |
|
Última modificação
|
last_modified | string |
Última modificação de dados no workspace. |
|
Limitar dados do projeto público
|
limit_public_project_data | boolean |
Limite os dados de projetos públicos em relatórios aos administradores. |
|
URL do logótipo
|
logo_url | string |
URL do logotipo do workspace. |
|
Dias máximos de retenção de dados
|
max_data_retention_days | object |
Até onde os workspaces gratuitos podem acessar dados. |
|
Nome do workspace
|
name | string |
Nome do workspace. |
|
Somente administradores podem criar projetos
|
only_admins_may_create_projects | boolean |
Somente os administradores poderão criar projetos. |
|
Somente administradores podem criar marcas
|
only_admins_may_create_tags | boolean |
Somente os administradores poderão criar marcas. |
|
Somente administradores veem o painel da equipe
|
only_admins_see_team_dashboard | boolean |
Somente os administradores poderão ver o painel da equipe. |
|
ID da organização
|
organization_id | integer |
Identificador da organização. |
|
Permissions
|
permissions | array of string |
Lista de permissões. |
|
Premium
|
premium | boolean |
Workspace na assinatura Starter. |
|
Projetos faturáveis por padrão
|
projects_billable_by_default | boolean |
Novos projetos faturáveis por padrão. |
|
Projetos impõem cobrança
|
projects_enforce_billable | boolean |
Se o tempo de acompanhamento para projetos imporá que a configuração faturável seja respeitada. |
|
Projetos privados por padrão
|
projects_private_by_default | boolean |
Configuração do workspace para visibilidade padrão do projeto. |
|
Taxa Última Atualização
|
rate_last_updated | string |
Carimbo de data/hora da última atualização de taxa de workspace. |
|
Recolhimento de relatórios
|
reports_collapse | boolean |
Se os relatórios devem ser recolhidos por padrão. |
|
Função
|
role | string |
Função do usuário atual no workspace. |
|
Arredondamento
|
rounding | integer |
Arredondamento padrão, recurso premium. 0 - mais próximo, 1 - arredondar para cima, -1 - arredondar para baixo. |
|
Minutos de arredondamento
|
rounding_minutes | integer |
Arredondamento padrão em minutos, recurso premium. |
|
Subscription
|
subscription | object |
Detalhes da assinatura (preterido). |
|
Suspenso em
|
suspended_at | string |
Carimbo de data/hora de suspensão. |
|
Restrições de entrada de tempo
|
te_constraints | object |
Configuração de restrições de entrada de tempo. |
|
Horas de trabalho em minutos
|
working_hours_in_minutes | integer |
Horas de trabalho em minutos. |
Característica
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Enabled
|
enabled | boolean |
Se o recurso está habilitado ou não. |
|
ID do Recurso
|
feature_id | integer |
ID do recurso. |
|
Nome do recurso
|
name | string |
Nome do recurso. |
Recursos do espaço de trabalho
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Features
|
features | array of Feature |
Lista de recursos. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace. |
LocationResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
City
|
city | string |
Nome da cidade. |
|
Coordenadas da cidade
|
city_lat_long | string |
Latitude e longitude da cidade. |
|
Código do país
|
country_code | string |
Código do país. |
|
Nome do país
|
country_name | string |
Nome do país. |
|
Estado
|
state | string |
Estado ou região. |
Organização
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Admin
|
admin | boolean |
Se o solicitante é um administrador da organização. |
|
Última modificação
|
at | string |
Data da última modificação da organização. |
|
Criado em
|
created_at | string |
Data de criação da organização. |
|
ID da organização
|
id | integer |
ID da organização. |
|
Vários workspaces habilitados
|
is_multi_workspace_enabled | boolean |
É verdadeiro quando a opção da organização is_multi_workspace_enabled é definida. |
|
É Unificado
|
is_unified | boolean |
É uma organização unificada. |
|
Dias máximos de retenção de dados
|
max_data_retention_days | object |
O quão distantes os workspaces gratuitos nesta organização podem acessar dados. |
|
Máximo de workspaces
|
max_workspaces | integer |
Número máximo de workspaces permitidos para a organização. |
|
Nome da Organização
|
name | string |
Nome da organização. |
|
Proprietário
|
owner | boolean |
Se o solicitante é o proprietário da organização. |
|
Permissions
|
permissions | array of string |
Permissões da organização. |
|
Plano de preços Enterprise
|
pricing_plan_enterprise | boolean |
O plano de assinatura é um plano corporativo. |
|
ID do plano de preços
|
pricing_plan_id | integer |
ID do plano da organização. |
|
Nome do plano de preços
|
pricing_plan_name | string |
O nome do plano de assinatura em que a organização está atualmente. |
|
Suspenso em
|
suspended_at | string |
Se a organização está suspensa no momento. |
|
trial_info
|
trial_info | TrialInfo | |
|
Contagem de Usuários
|
user_count | integer |
Número de usuários da organização. |
TrialInfo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Pode ter avaliação
|
can_have_trial | boolean |
É verdade se nem a organização nem o proprietário nunca tiveram uma avaliação antes. |
|
ID do último plano de preços
|
last_pricing_plan_id | integer |
Última ID do plano de preços. |
|
Próxima Data de Pagamento
|
next_payment_date | string |
Próxima data de pagamento. |
|
Avaliação
|
trial | boolean |
Se a assinatura da organização está em avaliação no momento. |
|
Avaliação disponível
|
trial_available | boolean |
Quando uma avaliação está disponível para essa organização (preterida). |
|
Data de término da avaliação
|
trial_end_date | string |
Data de término da avaliação. |
|
ID do plano de avaliação
|
trial_plan_id | integer |
ID do plano de avaliação. |
TrackReminder
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
created_at | string |
Hora de criação do lembrete. |
|
Frequência
|
frequency | integer |
A frequência do lembrete em dias deve ser 1 ou 7. |
|
IDs de grupo
|
group_ids | array of integer |
Agrupa IDs para as qual enviar o lembrete. |
|
ID do lembrete
|
reminder_id | integer |
ID do lembrete. |
|
Limite
|
threshold | integer |
Limite é o número de horas após o qual o lembrete será enviado. |
|
IDs de usuário
|
user_ids | array of integer |
IDs de usuário para as quais enviar o lembrete. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace. |
TrackRemindersResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Acompanhar lembretes
|
items | array of TrackReminder |
Retorna uma lista de lembretes de faixa. |
BulkEditResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Falhas
|
failure | array of BulkEditFailure |
Lista de operações com falha. |
|
IDs de sucesso
|
success | array of integer |
As IDs para as quais o patch foi bem-sucedido. |
BulkEditFailure
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID com falha
|
id | integer |
A ID para a qual a operação de patch falhou. |
|
Mensagem de erro
|
message | string |
O motivo da falha da operação. |
WorkspaceUser
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
2FA Habilitada
|
2fa_enabled | boolean |
Sinalizador que indica se o uso tem 2FA habilitado ou não. |
|
Active
|
active | boolean |
Sinalizador indicando se o usuário aceitou o convite. |
|
Admin
|
admin | boolean |
Sinalizador indicando se o usuário é administrador. |
|
Última Atualização
|
at | string |
Carimbo de data/hora da última atualização. |
|
Avatar URL
|
avatar_file_name | string |
URL do avatar. |
|
Email
|
string |
Email do usuário. |
|
|
IDs de grupo
|
group_ids | array of integer |
Lista de grupos aos quais o usuário pertence. |
|
ID do workspace do usuário
|
id | integer |
Identificador do workspace do usuário. |
|
Inativos
|
inactive | boolean |
Sinalizador que indica se o usuário foi desativado pelo administrador do workspace. |
|
Código de convite
|
invitation_code | string |
Código de convite interno. |
|
CONVIDAR URL
|
invite_url | string |
URL de convite interno. |
|
É Membro Direto
|
is_direct | boolean |
Sinalizador que indica se o usuário é um membro direto do workspace (não é atribuído ao workspace usando o grupo). |
|
Custo da Mão-de-obra
|
labor_cost | double |
Custo de mão-de-obra atribuído ao usuário. |
|
Custo da mão-de-obra última atualização
|
labor_cost_last_updated | string |
Carimbo de data/hora da última atualização de custo de mão-de-obra. |
|
Nome
|
name | string |
Nome do utilizador. |
|
Administrador da organização
|
organization_admin | boolean |
Sinalizador indicando se o usuário é administrador dentro da organização. |
|
Rate
|
rate | double |
Taxa atribuída ao usuário. |
|
Taxa Última Atualização
|
rate_last_updated | string |
Carimbo de data/hora da última atualização de taxa. |
|
Função
|
role | string |
Função do utilizador. |
|
ID de Função
|
role_id | integer |
ID da função. |
|
Timezone
|
timezone | string |
Fuso horário do usuário. |
|
ID do usuário global
|
uid | integer |
Identificador de usuário global. |
|
ID do Usuário
|
user_id | integer |
Campo JSON alternativo userID, usado apenas por get-organization-workspaces-workspaceusers. |
|
Exibir editar taxas faturáveis
|
view_edit_billable_rates | boolean |
Sinalizadores de permissão de taxa granular. Só entra em vigor em funções com permissões de taxa condicional. |
|
Exibir Editar Custos trabalhistas
|
view_edit_labor_costs | boolean |
Exiba a permissão editar custos de mão-de-obra. |
|
ID do workspace
|
wid | integer |
Identificador do espaço de trabalho. |
|
Horas de trabalho em minutos
|
working_hours_in_minutes | integer |
Valor de horas de trabalho em minutos. |
|
Administrador do workspace
|
workspace_admin | boolean |
Sinalizador indicando se o usuário é administrador dentro do workspace. |
|
ID do workspace
|
workspace_id | integer |
Campo JSON alternativo userID, usado apenas por get-organization-workspaces-workspaceusers. |
Rate
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Quantidade
|
amount | double |
Quantidade da taxa. |
|
Criado em
|
created_at | string |
Data de criação da taxa. |
|
ID do Criador
|
creator_id | integer |
ID do criador. |
|
Excluído em
|
deleted_at | string |
Data de exclusão da taxa, caso isso seja nulo, significa que as taxas estão ativas. |
|
Data de Término
|
end | string |
Hora da data de término da taxa. |
|
ID da taxa
|
id | integer |
Identificador da taxa. |
|
ID da tarefa planejada
|
planned_task_id | integer |
ID de tarefa planejada que a taxa é aplicada. |
|
ID do projeto
|
project_id | integer |
ID do projeto que a taxa é aplicada. |
|
ID do usuário do projeto
|
project_user_id | integer |
ID do usuário do projeto que a taxa é aplicada. |
|
Modo de Alteração de Taxa
|
rate_change_mode | string |
Modo de alteração de taxa. |
|
Data de Início
|
start | string |
Data de início da taxa. |
|
Tipo
|
type | string |
Tipo de taxa. |
|
Atualizado em
|
updated_at | string |
Data da última atualização da taxa. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace que a taxa é aplicada. |
|
ID do usuário do workspace
|
workspace_user_id | integer |
ID do usuário do workspace que a taxa é aplicada. |
WorkspaceStatistics
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Administradores
|
admins | array of WorkspaceAdmin |
Lista de administradores do workspace. |
|
Contagem de grupos
|
groups_count | integer |
Número de grupos no workspace. |
|
Contagem de membros
|
members_count | integer |
Número de membros no workspace. |
WorkspaceAdmin
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
Nome do administrador. |
|
ID do Usuário
|
user_id | integer |
ID do usuário administrador. |
TimeEntryConstraints
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Descrição necessária
|
description_present | boolean |
A descrição é necessária para entradas de tempo. |
|
Projeto Necessário
|
project_present | boolean |
O projeto é necessário para entradas de tempo. |
|
Marcação necessária
|
tag_present | boolean |
A marca é necessária para entradas de tempo. |
|
Tarefa necessária
|
task_present | boolean |
A tarefa é necessária para entradas de tempo. |
|
Restrições habilitadas
|
time_entry_constraints_enabled | boolean |
As restrições de entrada de tempo estão habilitadas. |
WorkspaceUserSimple
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Email
|
string |
Email do usuário. |
|
|
Nome Completo
|
fullname | string |
Nome do utilizador. |
|
ID do Usuário
|
id | integer |
Identificador de usuário global. |
|
Inativos
|
inactive | boolean |
Inativo indica se o usuário está desativado ou não no workspace. |
|
Está ativo
|
is_active | boolean |
IsActive indica se o usuário ingressou no workspace. |
|
É administrador (preterido)
|
is_admin | boolean |
Sinalizador que indica se o usuário é administrador (preterido). |
|
Função
|
role | string |
Função do utilizador. |
ProjectUser
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Última modificação
|
at | string |
Quando foi modificado pela última vez. |
|
ID do grupo (herdado)
|
gid | integer |
ID do grupo, campo herdado. |
|
ID do grupo
|
group_id | integer |
ID do grupo. |
|
ID do usuário do projeto
|
id | integer |
ID do Usuário do Projeto. |
|
Custo da Mão-de-obra
|
labor_cost | double |
Custo de mão-de-obra para este usuário do projeto. |
|
Custo da mão-de-obra última atualização
|
labor_cost_last_updated | string |
Data da última atualização do custo da mão-de-obra. |
|
Gerente
|
manager | boolean |
Se o usuário é gerente do projeto. |
|
ID do projeto
|
project_id | integer |
ID do projeto. |
|
Rate
|
rate | double |
Taxa para este usuário do projeto. |
|
Taxa Última Atualização
|
rate_last_updated | string |
Data da última atualização da taxa. |
|
ID do Usuário
|
user_id | integer |
ID de usuário. |
|
ID do workspace
|
workspace_id | integer |
ID do workspace. |
TimeEntryWebhookEvent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento
|
event_id | integer |
Identificador exclusivo para o evento de webhook. |
|
ID da assinatura
|
subscription_id | integer |
ID da assinatura do webhook que disparou esse evento. |
|
Evento criado em
|
created_at | string |
Quando o evento foi criado. |
|
Timestamp do evento
|
timestamp | string |
Quando o evento foi enviado. |
|
ID do Criador
|
creator_id | integer |
ID do usuário que disparou o evento. |
|
URL de retorno de chamada
|
url_callback | string |
A URL de retorno de chamada para esse evento. |
|
Tipo de solicitação
|
metadata.request_type | string |
Tipo de solicitação que disparou o evento. |
|
ID do usuário do evento
|
metadata.event_user_id | integer |
ID do usuário associado ao evento. |
|
Ação
|
metadata.action | string |
Ação que foi executada (criada, atualizada, excluída, iniciada, interrompida). |
|
conteúdo
|
payload | TimeEntry |