Freigeben über


Timeneye (Preview)

This interface allows users to integrate Timeneye's time tracking and management capabilities with various applications and services in the Microsoft ecosystem. By leveraging this interface, users can automate workflows, synchronize time tracking data, and enhance productivity through seamless integration with other tools.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Support
URL https://support.timeneye.com/
Email info@timeneye.com
Connector Metadata
Publisher DM Digital Software SRL

Timeneye API Connector

Timeneye is a time tracking tool designed to help you manage your projects efficiently. This connector enables you to interact with Timeneye via the API, allowing you to integrate your time tracking data with various services.

Prerequisites

Before using this connector, you will need:

  1. A Timeneye account. If you don't have one, you can sign up here.

Getting Started

Set Up the Connector:

  • Open the Power Platform and go to the connectors section.
  • Search for the Timeneye connector.
  • Authenticate using the OAuth 2.0 flow when prompted.

Rate limiting

In order to be able to offer a reliable service to all our users and customers we limit how many requests can be performed per token every 5 minutes.

Every token has a limited number of requests (in the table below) that can be performed in a given window of time. The requests count is reset every 5 minutes.

The number of requests that can be performed every 5 minutes changes based on which plan has the user's account, at the moment of the request.

Plan Maximum requests per 5 minutes
Free 500
Business (any tier)/PRO 2000

In case the limit is reached, the following requests (for the given token) will receive a 429 error.

The response will contain the following headers: | Header | Example value | Description | |--|--|--| | X-RateLimit-Limit | 2000 | How many requests you can make | | X-RateLimit-Remaining | 0 | How many remaining requests are left | | Retry-After | 177 | Indicates how many seconds to wait before making a follow-up request.| | X-RateLimit-Reset | 1691677002 | Indicates when the limit resets (UNIX timestamp) |

Errors

All our API endpoints return a 200 HTTP status code when everything works as expected, but sometimes it may return an error.

Our APIs return different error codes based on the failure cause, ranging from missing parameters to server errors on our side.

In the table below you find a list of all our error codes with a generic description of the cause, in case the endpoint doesn't return a description of the specific case.

Code Meaning Description
400 Bad request One or multiple required parameters are missing or invalid.
401 Unauthorized The authorization token is missing, invalid or expired.
403 Forbidden Both the authentication and the request syntax are correct, but the resource you're trying to edit requires an access level that the authorized user doesn't have.
403 Not found The requested resource is not available.
403 Not found The requested resource is not available.
422 Validation The parameters or the payload passed does not follow the required specification
429 Too many requests You have reached your rate limit.
500 Internal server error There was a problem on our side..

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create a Budget

Creates a budget

Create a Client

Creates a client

Create a Group

Create Group

Create a Phase

Create a new phase

Create a Phase Category

Creates a phase category

Create a Project

Creates a project

Create a Tag

Creates a tag

Create a Tag List

Creates a tag list

Create a Timer

Creates a timer

Create a Todo

Create a todo

Create a Todo List

Create a todo list

Create an Avatar

Creates an avatar

Create an Entry

Creates an entry

Create Group-Project relationship

Attach a project to a group

Create Group-User relationship

Attach a user to a group

Create Project-Tag List relationship

Create Project-Tag list relationship

Create Project-Tag relationship

Create Project-Tag list relationship

Create Project-User relationship

Attach a user to a project

Delete a Budget

Deletes a budget

Delete a Client

Deletes a client

Delete a Group

Delete a group

Delete a Phase

Deletes a phase

Delete a Phase Category

Delete a phase category

Delete a Project

Deletes a project

Delete a Tag

Deletes a tag

Delete a Tag List

Deletes a tag list

Delete a Timer

Delete a timer

Delete a Todo

Deletes a todo

Delete a Todo List

Deletes a todo list

Delete a User

Deletes a user

Delete an Entry

Delete an entry

Delete an Entry Suggestion

Deletes an entry suggestion

Delete Group-Project relationship

Removed a project from a group

Delete Group-User relationship

Removed a user from a group

Delete Project-Tag List relationship

Remove project-tag list relationship

Delete Project-Tag relationship

Remove project-tag relationship

Delete Project-User relationship

Removed a user from a project

Get a Budget

Get a budget

Get a Client

Get a client

Get a Group

Get a group

Get a Phase

Gets a phase

Get a Phase Category

Get a phase category

Get a Project

Gets a project

Get a Tag

Get a single tag

Get a Tag List

Gets a single tag list

Get a Timer

Get a timer

Get a Todo

Gets a single todo

Get a Todo List

Gets a single todo list

Get a User

Gets a single user

Get Account

Gets the information on the user account

Get Entries

Get an entry

List Budgets

Get budgets list

List Clients

Get clients list

List Countries

Get countries list

List Currencies

Get currencies list

List Entries

Get entries list

List Entry Suggestions

Get a list of Entry suggestions for a given timeframe

List Groups

Get the list of all the groups

List Languages

Get languages list

List Phase Categories

Get the list of the phase categories

List Phases

List all the phases

List Projects

Get a list of projects

List Tag Lists

Get tag lists list

List Tags

Get list of tags

List Timers

Get timers list

List Todo Lists

Get a list of todo lists

List Todos

Get a list of todos

List Users

Get a list of users

List Zones

Get zones list

Update a Budget

Updates a budget

Update a Client

Updates a client

Update a Group

Update a Group

Update a Phase

Updates a phase

Update a Phase Category

Update a phase category

Update a Project

Updates a project

Update a Tag

Updates a tag

Update a Tag List

Updates a tag list

Update a Timer

Updates a timer

Update a Todo

Updates a todo

Update a Todo List

Updates a tag list

Update a User

Updates a user

Update Account

Updates an account

Update an Entry

Updates an entry

Update Group-User relationship

Updates the relationship between a user and a group

Update Project-Tag List relationship

Update project-tag list relationship

Update Project-Tag relationship

Update project-tag list relationship

Update Project-User relationship

Updates the relationship between a project and a user

Create a Budget

Creates a budget

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

budget_minutes
budget_minutes True integer

The amount of minutes the budget represents

interval
interval integer

Recurrence of the budget: 0 = no recurrence, 1 = weekly, 2 = monthly

project_id
project_id True integer

Identifier of the project to which the budget belongs

recurrence
recurrence True integer

Recurrence of the budget: 0 = no recurrence, 1 = weekly, 2 = monthly

Returns

Name Path Type Description
budget_id
budget_id integer

Unique identifier of the budget

budget_minutes
budget_minutes integer

The amount of minutes the budget represents

interval
interval integer

Day of budget reset: 1 to 31 if the budget is monthly, 0 to 6 if the budget is weekly

is_active
is_active integer

Whether or not the budget is active

period_end
period_end string

Format: YYYY-MM-DD

period_start
period_start string

Format: YYYY-MM-DD

project_id
project_id integer

Identifier of the project to which the budget belongs

recurrence
recurrence integer

Recurrence of the budget: 0 = no recurrence, 1 = weekly, 2 = monthly

Create a Client

Creates a client

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

color
color True string

Color used in reports

name
name True string

Name of the client

Returns

Name Path Type Description
client_id
client_id integer

Unique identifier

color
color string

Color used in reports

is_active
is_active boolean

Whether or not the client is archived

name
name string

Name of the client

Create a Group

Create Group

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

color
color string

The color used for reporting

name
name string

Name of the group

Returns

Name Path Type Description
color
color string

The color used for reporting

group_id
group_id integer

Unique identifier

name
name string

Name of the group

Create a Phase

Create a new phase

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

budget_minutes
budget_minutes True integer

Amount of budgeted time for theis phase. The sum of the budget_minutes of the phases must not be grater than the budgeted time for the project

name
name True string

The name of the phase

phase_category_id
phase_category_id integer

Unique identifier of the phase category which the phase belongs to

project_id
project_id True integer

Amount of budgeted time for theis phase. The sum of the budget_minutes of the phases must not be grater than the budgeted time for the project

Returns

Name Path Type Description
budget_minutes
budget_minutes integer

Amount of budgeted time for theis phase. The sum of the budget_minutes of the phases must not be grater than the budgeted time for the project

is_open
is_open integer

Whether or not the phase is archived

name
name string

The name of the phase

phase_category_id
phase_category_id integer

Unique identifier of the phase category which the phase belongs to

phase_id
phase_id integer

Unique identifier

project_id
project_id integer

Unique identifier of the project which the phase belongs to

Create a Phase Category

Creates a phase category

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

color
color string

The color used for reporting

name
name True string

Name of the phase category

Returns

Name Path Type Description
color
color string

The color used for reporting

name
name string

Name of the phase category

phase_category_id
phase_category_id integer

Unique identifier

Create a Project

Creates a project

Parameters

Name Key Required Type Description
api_only
api_only boolean

Whether or not the project is public, meaning that it is visible by all the users in the workspace and everybody can track time on it

client_id
client_id integer

Whether or not the project is public, meaning that it is visible by all the users in the workspace and everybody can track time on it

color
color True string

The color used for reporting

description
description string

A text description of the project

hourly_rate
hourly_rate number

The color used for reporting

is_billable
is_billable boolean

Whether or not the project is public, meaning that it is visible by all the users in the workspace and everybody can track time on it

is_public
is_public boolean

Whether or not the project is public, meaning that it is visible by all the users in the workspace and everybody can track time on it

name
name True string

The project's name

Returns

Name Path Type Description
api_only
api_only integer

Whether or not the project is usable for tracking time only using the apis.

client_id
client_id integer

Unique identifier of a client that the project belongs to

color
color string

The color used for reporting

description
description string

A text description of the project

hourly_rate
hourly_rate string

The general hourly rate for the project. A specific hourly_rate can be set on the project-user relation

is_active
is_active integer

Whether or not the project is archived

is_billable
is_billable integer

Whether or not the project is billable per hour

is_public
is_public integer

Whether or not the project is public, meaning that it is visible by all the users in the workspace and everybody can track time on it

name
name string

The project's name

project_id
project_id integer

Unique identifier

Create a Tag

Creates a tag

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

name
name True string

The name of the tag

tag_list_id
tag_list_id True integer

Unique identifier of the tag list which the tag belongs to

Returns

Create a Tag List

Creates a tag list

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

color
color string

The color used for reporting

name
name string

The name of the tag list

text_color
text_color string

The color of the text used for reporting

Returns

Create a Timer

Creates a timer

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

date
date string

Date of the timer

entry_suggestion_id
entry_suggestion_id integer

A unique identifier of the entry suggestion from which the timer is created

notes
notes string

Notes on the timer

origin_date
origin_date string

Format Y-m-d required with repeatable_suggestion_id

phase_id
phase_id True integer

Unique identifier of the the phase which the timer belongs to

project_id
project_id True integer

Unique identifier of the project

repeatable_suggestion_id
repeatable_suggestion_id integer

A unique identifier of the repeatable entry suggestion from which the timer is created

seconds
seconds integer
source
source string

Must be one of integration_code available or "consistency"

source_text
source_text string

A text that describes the source of the timer

source_url
source_url string

A text that describes the source of the timer

tag_ids
tag_ids array of integer

Array of tag_id

timer_status
timer_status True string
user_id
user_id integer

Unique identifier of the user that created the timer

Returns

response
object

Create a Todo

Create a todo

Parameters

Name Key Required Type Description
description
description string

Description of the todo

due_date
due_date string

The data by which the todo should be completed

index
index integer

The index of the todo in the list (order)

is_completed
is_completed boolean

Whether or not the todo is marked as done

name
name True string

Title of the todo

priority
priority string

Whether or not the todo is marked as done

start_date
start_date string

The date in which the todo should be taken in charge

status
status string

The current status of the todo

tag_ids
tag_ids array of integer

Array of tag_id to be linked to the todo

todo_list_id
todo_list_id True integer

Unique identifier of the todo list which the todo belongs to

user_id
user_id True integer

Unique identifier of the user assigned to the todo

user_ids
user_ids array of integer

Array of user_id representing users that are assigned to the todo

Returns

response
object

Create a Todo List

Create a todo list

Parameters

Name Key Required Type Description
color
color True string

The color used for reporting

index
index integer

The color used for reporting

name
name True string

Name of the todo list

project_id
project_id True integer

Unique identifier of the project which the todo list belongs to

Returns

Name Path Type Description
color
color string

The color used for reporting

created_at
created_at string

Created date and time

index
index integer

The index of the todo list in the board (order)

name
name string

Name of the todo list

project_id
project_id integer

Unique identifier of the project which the todo list belongs to

todo_list_id
todo_list_id integer

Unique identifier

updated_at
updated_at string

Updated date and time

Create an Avatar

Creates an avatar

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

image
image True binary

A file containing an image

user_id
user_id integer

Identifier of the user which has this avatar

account_id
account_id integer

Identifier of the account which has this avatar

Returns

Name Path Type Description
account_id
account_id integer

Identifier of the account which has this avatar

avatar_name
avatar_name string

unique file name

avatar_url
avatar_url string

Image url

user_id
user_id integer

Identifier of the user which has this avatar

Create an Entry

Creates an entry

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

billed
billed integer

0 = Entry billable, 1 = Entry billed, 2 = Entry not billable

date
date True string

Date of the entry

entry_suggestion_id
entry_suggestion_id integer

A unique identifier of the entry suggestion from which the entry is created

minutes
minutes True integer

Amount of tracked time in minutes

notes
notes string

Notes on the time entry

origin_date
origin_date string

Format Y-m-d required with repeatable_suggestion_id

phase_id
phase_id True integer

Unique identifier of the the phase which the entry belongs to

project_id
project_id True integer

Unique identifier of the project

repeatable_suggestion_id
repeatable_suggestion_id integer

A unique identifier of the repeatable entry suggestion from which the entry is created

source
source string

Must be one of integration_code available or "consistency"

source_text
source_text string

A text that describes the source of the entry

source_url
source_url string

A text that describes the source of the entry

tag_ids
tag_ids array of integer

Array of tag_id

user_id
user_id integer

Unique identifier of the user that created the entry

Returns

response
object

Create Group-Project relationship

Attach a project to a group

Parameters

Name Key Required Type Description
group
group True string
project
project True string
Accept
Accept string

application/json

Create Group-User relationship

Attach a user to a group

Parameters

Name Key Required Type Description
group
group True string
user
user True string
Accept
Accept string

application/json

is_gm
is_gm boolean

Tells if the user is group manager of the group

Create Project-Tag List relationship

Create Project-Tag list relationship

Parameters

Name Key Required Type Description
project
project True string
tag_list
tag_list True string
budget_amount
budget_amount number

The budgeted amount allocated to this tag list on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this tag list on this project

budget_amount
budget_amount number

The budgeted amount allocated to this tag list on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this tag list on this project

required
required boolean

Whether or not the tag is required for time entries of this project

Returns

Create Project-Tag relationship

Create Project-Tag list relationship

Parameters

Name Key Required Type Description
project
project True string
tag
tag True string
budget_amount
budget_amount number

The budgeted amount allocated to this tag on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this tag on this project

budget_amount
budget_amount number

The budgeted amount allocated to this tag on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this tag on this project

Returns

Create Project-User relationship

Attach a user to a project

Parameters

Name Key Required Type Description
project
project True string
user
user True string
Accept
Accept string

application/json

budget_minutes
budget_minutes integer

The minutes budgeted for this user in this project

hourly_rate
hourly_rate number

The hourly rate for this user in this project. Takes precedence over the hourly rate at project level and hourly rate at account level

is_favorited
is_favorited boolean

Whether or not the project is favorited by the user

is_pm
is_pm boolean

Whether or not the user is project manager of the project

Returns

Delete a Budget

Deletes a budget

Parameters

Name Key Required Type Description
budget
budget True string
Accept
Accept string

application/json

Delete a Client

Deletes a client

Parameters

Name Key Required Type Description
client
client True string
Accept
Accept string

application/json

Delete a Group

Delete a group

Parameters

Name Key Required Type Description
group
group True string
Accept
Accept string

application/json

Delete a Phase

Deletes a phase

Parameters

Name Key Required Type Description
phase
phase True string
Accept
Accept string

application/json

Delete a Phase Category

Delete a phase category

Parameters

Name Key Required Type Description
phase_category
phase_category True string
Accept
Accept string

application/json

Delete a Project

Deletes a project

Parameters

Name Key Required Type Description
project
project True string
Accept
Accept string

application/json

Delete a Tag

Deletes a tag

Parameters

Name Key Required Type Description
tag
tag True string
Accept
Accept string

application/json

Delete a Tag List

Deletes a tag list

Parameters

Name Key Required Type Description
tag_list
tag_list True string
Accept
Accept string

application/json

Delete a Timer

Delete a timer

Parameters

Name Key Required Type Description
timer
timer True string
Accept
Accept string

application/json

Delete a Todo

Deletes a todo

Parameters

Name Key Required Type Description
todo
todo True string
Accept
Accept string

application/json

Delete a Todo List

Deletes a todo list

Parameters

Name Key Required Type Description
todo_list
todo_list True string
Accept
Accept string

application/json

Delete a User

Deletes a user

Parameters

Name Key Required Type Description
user
user True string
Accept
Accept string

application/json

Delete an Entry

Delete an entry

Parameters

Name Key Required Type Description
entry
entry True string
Accept
Accept string

application/json

Returns

Delete an Entry Suggestion

Deletes an entry suggestion

Parameters

Name Key Required Type Description
entry_suggestion
entry_suggestion True string
Accept
Accept string

application/json

Delete Group-Project relationship

Removed a project from a group

Parameters

Name Key Required Type Description
group
group True string
project
project True string
Accept
Accept string

application/json

Delete Group-User relationship

Removed a user from a group

Parameters

Name Key Required Type Description
group
group True string
user
user True string
Accept
Accept string

application/json

Delete Project-Tag List relationship

Remove project-tag list relationship

Parameters

Name Key Required Type Description
project
project True string
tag_list
tag_list True string

Delete Project-Tag relationship

Remove project-tag relationship

Parameters

Name Key Required Type Description
project
project True string
tag
tag True string

Delete Project-User relationship

Removed a user from a project

Parameters

Name Key Required Type Description
project
project True string
user
user True string
Accept
Accept string

application/json

Get a Budget

Get a budget

Parameters

Name Key Required Type Description
budget
budget True string
Accept
Accept string

application/json

Returns

Name Path Type Description
budget_id
budget_id integer

Unique identifier of the budget

budget_minutes
budget_minutes integer

The amount of minutes the budget represents

interval
interval integer

Day of budget reset: 1 to 31 if the budget is monthly, 0 to 6 if the budget is weekly

is_active
is_active integer

Whether or not the budget is active

period_end
period_end string

Format: YYYY-MM-DD

period_start
period_start string

Format: YYYY-MM-DD

project_id
project_id integer

Identifier of the project to which the budget belongs

recurrence
recurrence integer

Recurrence of the budget: 0 = no recurrence, 1 = weekly, 2 = monthly

Get a Client

Get a client

Parameters

Name Key Required Type Description
client
client True string
Accept
Accept string

application/json

Returns

Get a Group

Get a group

Parameters

Name Key Required Type Description
group
group True string
Accept
Accept string

application/json

Returns

Get a Phase

Gets a phase

Parameters

Name Key Required Type Description
phase
phase True string
Accept
Accept string

application/json

Returns

Get a Phase Category

Get a phase category

Parameters

Name Key Required Type Description
phase_category
phase_category True string
Accept
Accept string

application/json

Returns

Name Path Type Description
color
color string

The color used for reporting

name
name string

Name of the phase category

phase_category_id
phase_category_id integer

Unique identifier

Get a Project

Gets a project

Parameters

Name Key Required Type Description
project
project True string
Accept
Accept string

application/json

Returns

Get a Tag

Get a single tag

Parameters

Name Key Required Type Description
tag
tag True string
Accept
Accept string

application/json

Returns

Get a Tag List

Gets a single tag list

Parameters

Name Key Required Type Description
tag_list
tag_list True string

Returns

Get a Timer

Get a timer

Parameters

Name Key Required Type Description
timer
timer True string
Accept
Accept string

application/json

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

Get a Todo

Gets a single todo

Parameters

Name Key Required Type Description
todo
todo True string

Returns

response
object

Get a Todo List

Gets a single todo list

Parameters

Name Key Required Type Description
todo_list
todo_list True string

Returns

Get a User

Gets a single user

Parameters

Name Key Required Type Description
user
user True string

Returns

Get Account

Gets the information on the user account

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

Returns

Get Entries

Get an entry

Parameters

Name Key Required Type Description
entry
entry True string
Accept
Accept string

application/json

Returns

response
object

List Budgets

Get budgets list

Parameters

Name Key Required Type Description
page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

project_id
project_id integer

Identifier of the project to which the budget belongs

Accept
Accept string

application/json

Returns

Name Path Type Description
data
data array of object
budget_id
data.budget_id integer

Unique identifier of the budget

budget_minutes
data.budget_minutes integer

The amount of minutes the budget represents

interval
data.interval integer

Day of budget reset: 1 to 31 if the budget is monthly, 0 to 6 if the budget is weekly

is_active
data.is_active integer

Whether or not the budget is active

period_end
data.period_end string

Format: YYYY-MM-DD

period_start
data.period_start string

Format: YYYY-MM-DD

project_id
data.project_id integer

Identifier of the project to which the budget belongs

recurrence
data.recurrence integer

Recurrence of the budget: 0 = no recurrence, 1 = weekly, 2 = monthly

first
links.first string
last
links.last string
next
links.next string
prev
links.prev string
current_page
meta.current_page integer
from
meta.from integer
last_page
meta.last_page integer
links
meta.links array of object
active
meta.links.active boolean
label
meta.links.label string
url
meta.links.url string
path
meta.path string
per_page
meta.per_page integer
to
meta.to integer
total
meta.total integer

List Clients

Get clients list

Parameters

Name Key Required Type Description
page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

text
text string

Searches in the client's name

member_ids[]
member_ids[] string

A comma separated list of client ids to filter the results

Accept
Accept string

application/json

Returns

Name Path Type Description
data
data array of object
client_id
data.client_id integer

Unique identifier

color
data.color string

Color used in reports

is_active
data.is_active boolean

Whether or not the client is archived

name
data.name string

Name of the client

first
links.first string
last
links.last string
next
links.next string
prev
links.prev string
current_page
meta.current_page integer
from
meta.from integer
last_page
meta.last_page integer
links
meta.links array of object
active
meta.links.active boolean
label
meta.links.label string
url
meta.links.url string
path
meta.path string
per_page
meta.per_page integer
to
meta.to integer
total
meta.total integer

List Countries

Get countries list

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

Returns

Name Path Type Description
array of object
company_tax
company_tax string
country_code
country_code string
name
name string
private_tax
private_tax string
vat_required
vat_required integer

List Currencies

Get currencies list

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

Returns

Name Path Type Description
array of object
currency_code
currency_code string
name
name string

List Entries

Get entries list

Parameters

Name Key Required Type Description
page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

member_ids[]
member_ids[] string

A comma separated list of user ids to filter the results

entry_ids[]
entry_ids[] string

A comma separated list of entry ids to filter the results

project_ids[]
project_ids[] string

A comma separated list of project ids to filter the results

phase_ids[]
phase_ids[] string

A comma separated list of phase ids to filter the results

client_ids[]
client_ids[] string

A comma separated list of client ids to filter the results

group_ids[]
group_ids[] string

A comma separated list of group ids to filter the results

category_ids[]
category_ids[] string

A comma separated list of phase category ids to filter the results

tag_list_ids[]
tag_list_ids[] string

A comma separated list of tag list ids to filter the results

tag_ids[]
tag_ids[] string

A comma separated list of tag ids to filter the results

billed_status
billed_status integer

Get only the entry that have a given billed status: 0: Unbilled 1: Billed 2: Not billable 3: Billable

timeframe
timeframe string

Get only the entries in a given timeframe

date_from
date_from string

Get only the entries that have date grater or equal to this date

date_to
date_to string

Get only the entries that have date less or equal to this date

text
text string

Get entries that contain this text in the notes

Accept
Accept string

application/json

Returns

Name Path Type Description
data
data array of object
billed
data.billed integer

Indicates if the entry has been billed

client_id
data.client_id integer

Unique identifier of the client that belongs to the entry's project

cost
data.cost string

The monetary cost of the time entry based on the hourly cost of the user that created it

created_date
data.created_date string

Date and time of creation

entry_date
data.entry_date string

Date of the entry

entry_id
data.entry_id integer

Unique identifier

entry_minutes
data.entry_minutes integer

Amount of tracked time in minutes

locked
data.locked integer

Whether or not the entry is locked

locked_by_apionly
data.locked_by_apionly integer

Whether or not the entry is locked by restriction on third party app only

locked_by_date
data.locked_by_date integer

Whether or not the entry is locked by date

locked_by_membership
data.locked_by_membership integer

Whether or not the entry is locked by membership

notes
data.notes string

Notes on the time entry

phase_category_id
data.phase_category_id integer

Unique identifier of the the phase category which the entry's phase belongs to

phase_id
data.phase_id integer

Unique identifier of the the phase which the entry belongs to

profit
data.profit string

The difference between the revenue and the cost

project_id
data.project_id integer

Unique identifier of the project

revenue
data.revenue string

The monetary revenue of the time entry based on the general hourly rate,the project's .

source
data.source string

Indicates the source of the entry (if any)

source_data
data.source_data string

Additional data of the source

source_id
data.source_id string

A unique identifier of the source of the entry

source_text
data.source_text string

A text that describes the source of the entry

source_url
data.source_url string

An URL to the source of the entry

suggested_phase_id
data.suggested_phase_id string

An optional identifier of a suggested phase if the entry is created from an EntrySuggestion

suggested_project_id
data.suggested_project_id string

An optional identifier of a suggested project if the entry is created from an EntrySuggestion

todo_id
data.todo_id string

The unique identifier of a todo linked to the time entry

updated_date
data.updated_date string

Date and time od update

user_id
data.user_id integer

Unique identifier of the user that created the entry

first
links.first string
last
links.last string
next
links.next string
prev
links.prev string
current_page
meta.current_page integer
from
meta.from integer
last_page
meta.last_page integer
links
meta.links array of object
active
meta.links.active boolean
label
meta.links.label string
url
meta.links.url string
path
meta.path string
per_page
meta.per_page integer
to
meta.to integer
total
meta.total integer

List Entry Suggestions

Get a list of Entry suggestions for a given timeframe

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

no_paginate
no_paginate boolean

Get a full list of suggestions without paginating the results

timeframe
timeframe string

Get only the suggestions in a given timeframe

date_from
date_from string

Get only the suggestions that have date grater or equal to this date

date_to
date_to string

Get only the suggestions that have date less or equal to this date

Returns

Name Path Type Description
current_page
current_page integer
data
data array of object
accepted
data.accepted integer

Whether or not the suggestion is accepted an transformed into an entry

created_datetime
data.created_datetime string

Date and time of creation of the suggestion

entry_date
data.entry_date string

Suggested date

entry_minutes
data.entry_minutes integer

Suggested amount of time in minutes

entry_suggestion_id
data.entry_suggestion_id integer

Unique identifier

notes
data.notes string

Notes related to the source of the suggestion

phase_id
data.phase_id integer

Unique identifier of the suggested phase

phase_name
data.phase_name string

Name of the suggested phase

project_id
data.project_id integer

Unique identifier of the suggested project

project_name
data.project_name string

Name of the suggested project

source
data.source string

Source identifier

source_data
data.source_data string

Other data related to the source

source_id
data.source_id string

Unique identifier of the source

source_text
data.source_text string

Text related to the source

source_url
data.source_url string

URL of the source of the suggestion

todo_id
data.todo_id integer
user_id
data.user_id integer

Unique identifier of the user that owns the suggestion

first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Groups

Get the list of all the groups

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Languages

Get languages list

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

Returns

Name Path Type Description
array of object
language_code
language_code string

Unique identifier

name
name string

Name of the language

List Phase Categories

Get the list of the phase categories

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

text
text string

Full text search string

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Phases

List all the phases

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

text
text string

Get phases containing this text in the name

active
active boolean

Get only active or inactive phases

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

project_id
project_id integer

Get phases belonging to a project

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Projects

Get a list of projects

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

public
public boolean

Get only public projects

active
active boolean

Get only active projects

billable
billable boolean

Get only billable projects

load[]
load[] string

A comma separated list of entities to load. Possible values: users,budget,phases,groups

text
text string

Full text search

client_id
client_id integer

Get projects belonging to a client identified by this parameter

user_id
user_id integer

Search project in which the user is in the team

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Tag Lists

Get tag lists list

Parameters

Name Key Required Type Description
page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

project_id
project_id integer

Get tag lists belonging to a project

Accept
Accept string

application/json

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Tags

Get list of tags

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

name
name string

Text search in name

tag_list_id
tag_list_id integer

Id of a TagList

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

Returns

Name Path Type Description
current_page
current_page integer
data
data array of object
color
data.color string

The color used for reporting

is_active
data.is_active integer

Whether or not the tag is archived

name
data.name string

The name of the tag

tag_id
data.tag_id integer

Unique identifier

tag_list_id
data.tag_list_id integer

Unique identifier of the tag list which the tag belongs to

first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Timers

Get timers list

Parameters

Name Key Required Type Description
page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

date_from
date_from string

Get only the timers that have date grater or equal to this date

date_to
date_to string

Get only the timers that have date less or equal to this date

Accept
Accept string

application/json

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Todo Lists

Get a list of todo lists

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

project_id
project_id integer

Unique identifier of the project which the todo list belongs to

load[]
load[] string

A comma separated list of entities to load. '"todos" is the only accepted value'

Returns

Name Path Type Description
current_page
current_page integer
data
data array of object
items
data object
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Todos

Get a list of todos

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

project_id
project_id integer

Unique identifier of the project which the todo belongs to

todo_list_id
todo_list_id integer

Unique identifier of a todo list

user_ids[]
user_ids[] string

A comma separated list of User unique identifiers assigned to the todos

priority[]
priority[] string

A comma separated list of priorities: Allowed values: low, medium, high

status[]
status[] string

A comma separated list of statuses. Allowed values: todo, in_progress, completed

Returns

Name Path Type Description
current_page
current_page integer
data
data array of object
items
data object
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Users

Get a list of users

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

page
page integer

The currently displayed page

per_page
per_page integer

How many items per page

sort_by
sort_by string

The attribute to sort by

direction
direction string

The sort direction

text
text string

Full text search

name
name string

Search the users by name

email
email string

Search the users by email

status
status string

Search the users by status

active
active boolean

Search the users by active status

group_ids[]
group_ids[] string

A comma separated list of group ids to filter by

group_id
group_id string

Search the users that belong to a group

member_ids[]
member_ids[] string

A comma separated list of user ids to filter by

project_ids[]
project_ids[] string

A comma separated list of project ids to filter by

client_ids[]
client_ids[] string

A comma separated list of client ids to filter by

Returns

Name Path Type Description
current_page
current_page integer
data
data array of
first_page_url
first_page_url string
from
from integer
last_page
last_page integer
last_page_url
last_page_url string
next_page_url
next_page_url string
path
path string
per_page
per_page integer
prev_page_url
prev_page_url string
to
to integer
total
total integer

List Zones

Get zones list

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

Returns

Name Path Type Description
array of object
country_code
country_code string

Code of the country which the zone belongs to

name
name string

Name of the time zone

zone_id
zone_id integer

Unique identifier

Update a Budget

Updates a budget

Parameters

Name Key Required Type Description
budget
budget True string
Accept
Accept string

application/json

budget_minutes
budget_minutes integer

Day of budget reset: 1 to 31 if the budget is monthly, 0 to 6 if the budget is weekly

interval
interval integer

Day of budget reset: 1 to 31 if the budget is monthly, 0 to 6 if the budget is weekly

recurrence
recurrence integer

Recurrence of the budget: 0 = no recurrence, 1 = weekly, 2 = monthly

Returns

Name Path Type Description
budget_id
budget_id integer

Unique identifier of the budget

budget_minutes
budget_minutes integer

The amount of minutes the budget represents

interval
interval integer

Day of budget reset: 1 to 31 if the budget is monthly, 0 to 6 if the budget is weekly

is_active
is_active integer

Whether or not the budget is active

period_end
period_end string

Format: YYYY-MM-DD

period_start
period_start string

Format: YYYY-MM-DD

project_id
project_id integer

Identifier of the project to which the budget belongs

recurrence
recurrence integer

Recurrence of the budget: 0 = no recurrence, 1 = weekly, 2 = monthly

Update a Client

Updates a client

Parameters

Name Key Required Type Description
client
client True string
Accept
Accept string

application/json

color
color True string

Color used in reports

name
name True string

Color used in reports

Returns

Name Path Type Description
client_id
client_id integer

Unique identifier

color
color string

Color used in reports

is_active
is_active boolean

Whether or not the client is archived

name
name string

Name of the client

Update a Group

Update a Group

Parameters

Name Key Required Type Description
group
group True string
Accept
Accept string

application/json

color
color string

The color used for reporting

name
name string

Name of the group

Returns

Name Path Type Description
color
color string

The color used for reporting

group_id
group_id integer

Unique identifier

name
name string

Name of the group

Update a Phase

Updates a phase

Parameters

Name Key Required Type Description
phase
phase True string
Accept
Accept string

application/json

budget_minutes
budget_minutes integer

Amount of budgeted time for theis phase. The sum of the budget_minutes of the phases must not be grater than the budgeted time for the project

is_open
is_open integer

Whether or not the phase is archived

name
name string

The name of the phase

phase_category_id
phase_category_id integer

Unique identifier of the phase category which the phase belongs to

project_id
project_id integer

Unique identifier of the project which the phase belongs to

Returns

Update a Phase Category

Update a phase category

Parameters

Name Key Required Type Description
phase_category
phase_category True string
Accept
Accept string

application/json

color
color string

The color used for reporting

name
name string

Name of the phase category

Returns

Name Path Type Description
color
color string

The color used for reporting

name
name string

Name of the phase category

phase_category_id
phase_category_id integer

Unique identifier

Update a Project

Updates a project

Parameters

Name Key Required Type Description
project
project True string
Accept
Accept string

application/json

api_only
api_only boolean

Whether or not the project is usable for tracking time only using the apis.

client_id
client_id integer

Unique identifier of a client that the project belongs to

color
color string

The color used for reporting

description
description string

A text description of the project

hourly_rate
hourly_rate number

The color used for reporting

is_billable
is_billable boolean

Whether or not the project is billable per hour

is_public
is_public boolean

Whether or not the project is public, meaning that it is visible by all the users in the workspace and everybody can track time on it

name
name string

The project's name

Returns

Update a Tag

Updates a tag

Parameters

Name Key Required Type Description
tag
tag True string
Accept
Accept string

application/json

color
color string

The color used for reporting

name
name string

The name of the tag

tag_list_id
tag_list_id integer

Unique identifier of the tag list which the tag belongs to

Returns

Update a Tag List

Updates a tag list

Parameters

Name Key Required Type Description
tag_list
tag_list True string
color
color string

The color used for reporting

name
name string

The name of the tag list

text_color
text_color string

The color of the text used for reporting

Returns

Update a Timer

Updates a timer

Parameters

Name Key Required Type Description
timer
timer True string
Accept
Accept string

application/json

date
date string

Date of the timer

entry_suggestion_id
entry_suggestion_id integer

A unique identifier of the entry suggestion from which the timer is created

notes
notes string

Notes on the timer

origin_date
origin_date string

Format Y-m-d required with repeatable_suggestion_id

phase_id
phase_id True integer

Unique identifier of the the phase which the timer belongs to

project_id
project_id True integer

Unique identifier of the project

repeatable_suggestion_id
repeatable_suggestion_id integer

A unique identifier of the repeatable entry suggestion from which the timer is created

seconds
seconds integer
source
source string

Must be one of integration_code available or "consistency"

source_text
source_text string

A text that describes the source of the timer

source_url
source_url string

A text that describes the source of the timer

tag_ids
tag_ids array of integer

Array of tag_id

timer_status
timer_status True string
user_id
user_id integer

Unique identifier of the user that created the timer

Returns

Update a Todo

Updates a todo

Parameters

Name Key Required Type Description
todo
todo True string
description
description string

Description of the todo

due_date
due_date string

The data by which the todo should be completed

index
index integer

The index of the todo in the list (order)

is_completed
is_completed boolean

Whether or not the todo is marked as done

name
name string

Title of the todo

priority
priority string

Whether or not the todo is marked as done

project_id
project_id integer

Unique identifier of the project which the todo belongs to

start_date
start_date string

The date in which the todo should be taken in charge

status
status string

The current status of the todo

tag_ids
tag_ids array of integer

Array of tag_id to be linked to the todo

todo_list_id
todo_list_id integer

Unique identifier of the todo list which the todo belongs to

user_id
user_id integer

Unique identifier of the user assigned to the todo

user_ids
user_ids array of integer

Array of user_id representing users that are assigned to the todo

Returns

response
object

Update a Todo List

Updates a tag list

Parameters

Name Key Required Type Description
todo_list
todo_list True string
color
color True string

The color used for reporting

index
index integer

The color used for reporting

name
name True string

Name of the todo list

project_id
project_id True integer

Unique identifier of the project which the todo list belongs to

Returns

Name Path Type Description
color
color string

The color used for reporting

created_at
created_at string

Created date and time

index
index integer

The index of the todo list in the board (order)

name
name string

Name of the todo list

project_id
project_id integer

Unique identifier of the project which the todo list belongs to

todo_list_id
todo_list_id integer

Unique identifier

updated_at
updated_at string

Updated date and time

Update a User

Updates a user

Parameters

Name Key Required Type Description
user
user True string
group_id
group_id integer

Unique identifier of the group to which the user belongs to

user_hourly_cost
user_hourly_cost integer

The hourly cost of the user, expressed in the currency selected in the account settings

user_hourly_rate
user_hourly_rate integer

The hourly rate of the user, expressed in the currency selected in the account settings

working_time
working_time integer

How many hours the user is usually working on a day

workspace_access_level
workspace_access_level string

The role of the user in Timeneye: owner, admin or member

Returns

Update Account

Updates an account

Parameters

Name Key Required Type Description
Accept
Accept string

application/json

account_name
account_name string

The name of the account, usually the Company name.

adminNewEntryForOthers
adminNewEntryForOthers boolean

Possibility to add entries on behalf of other users

allow_password_login
allow_password_login boolean

Whether or not the login with email + password is allowed

idp_cert
idp_cert string

Certificate of the identity provider (used with type = saml)

idp_entity_id
idp_entity_id string

Id of the identity provider (used with type = saml)

idp_metadata_url
idp_metadata_url string

Id of the identity provider (used with type = saml)

idp_sso_url
idp_sso_url string

Single Sign on URL (used with type = saml)

type
type string

Type of login method

currencyCode
currencyCode string

Code of the used currency

enabled
enabled boolean

Whether or not the entry lock automation is enabled

interval
interval string

Interval of the entry lock

interval_target
interval_target number

Between 1 and 31 if the interval is monthly (the day of the month), Between 0 and 6i if the interval is weekly

memberAverageCost
memberAverageCost number

Indicates the average labour cost for the account members

showWorkingTime
showWorkingTime boolean

Whether or not the users can see their working time in their dashboard. (e.g. 7h of 8h)

Returns

Update an Entry

Updates an entry

Parameters

Name Key Required Type Description
entry
entry True string
Accept
Accept string

application/json

billed
billed integer

0 = Entry billable, 1 = Entry billed, 2 = Entry not billable

date
date string

Date of the entry

entry_suggestion_id
entry_suggestion_id integer

A unique identifier of the entry suggestion from which the entry is created

minutes
minutes integer

Amount of tracked time in minutes

notes
notes string

Notes on the time entry

origin_date
origin_date string

Format Y-m-d required with repeatable_suggestion_id

phase_id
phase_id integer

Unique identifier of the the phase which the entry belongs to

project_id
project_id integer

Unique identifier of the project

repeatable_suggestion_id
repeatable_suggestion_id integer

A unique identifier of the repeatable entry suggestion from which the entry is created

source
source string

Must be one of integration_code available or "consistency"

source_text
source_text string

A text that describes the source of the entry

source_url
source_url string

A text that describes the source of the entry

tag_ids
tag_ids array of integer

Array of tag_id

user_id
user_id integer

Unique identifier of the user that created the entry

Returns

Update Group-User relationship

Updates the relationship between a user and a group

Parameters

Name Key Required Type Description
group
group True string
user
user True string
Accept
Accept string

application/json

is_gm
is_gm boolean

Tells if the user is group manager of the group

Update Project-Tag List relationship

Update project-tag list relationship

Parameters

Name Key Required Type Description
project
project True string
tag_list
tag_list True string
budget_amount
budget_amount number

The budgeted amount allocated to this tag list on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this list tag on this project

budget_amount
budget_amount number

The budgeted amount allocated to this tag list on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this tag list on this project

required
required boolean

Returns

Update Project-Tag relationship

Update project-tag list relationship

Parameters

Name Key Required Type Description
project
project True string
tag
tag True string
budget_amount
budget_amount number

The budgeted amount allocated to this tag on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this tag on this project

budget_amount
budget_amount number

The budgeted amount allocated to this tag on this project

budget_minutes
budget_minutes integer

The budgeted minutes allocated to this tag on this project

Returns

Update Project-User relationship

Updates the relationship between a project and a user

Parameters

Name Key Required Type Description
project
project True string
user
user True string
budget_minutes
budget_minutes integer

The minutes budgeted for this user in this project

hourly_rate
hourly_rate number

The hourly rate for this user in this project. Takes precedence over the hourly rate at project level and hourly rate at account level

is_favorited
is_favorited boolean

Whether or not the project is favorited by the user

is_pm
is_pm boolean

Whether or not the user is project manager of the project

Returns

Definitions

object

This is the type 'object'.