Support for this API is no longer available. Please migrate your apps to our newest API version here. If you do not have yet access to the new app version plese contact our support team. For more information about our new APIs you can visit our Knowledge base here.
Timeneye APIs use the OAuth 2.0 flow for authentication.
In order to start using our apis you need to create a new app under your developer panel.
The newly created app will have a clientId, to identify your app, that can be used on public code (like JS) and a clientSecret which, you guessed it, must stay secret.
To get the access token needed to perform actions for your users, you need to ask them to authorize your app redirecting them to https://track.timeneye.com/authorize/{clientId}.
They will be showed a view with info about your app and they will be able to confirm or cancel the authorization.
In case they accept they will be redirected to the url you have configured as Redirect URI in your app settings, the redirect url will include also a code that you need later in order to get the access token.
Otherwise they will be redirected to the Cancel URI.This request has to be made specifying a specific header: Authorization: Basic XXX, where XXX is base64('[clientId]:[clientSecret]') and setting the appropriate code and clientId GET query parameters.
At this point to get the access token just call the Get token endpoint and you will get back an object containing accessToken, refreshToken and expiration.
Access tokens expire after 14 days, to get the new one just call the Refresh token endpoint.
From there on, you can call our endpoints adding a specific header Bearer: [accessToken].
In this page you will be able to test out all our endpoints using a temporary token that you can generate from your developer panel, clicking the "Get API docu. token" button.
All our API endpoints have as baseurl https://track.timeneye.com/api/3 and all calls must be performed via https.
CORS is supported.
All datetimes, both when returned and when expected as parameter, are in the MySQL format YYYY-MM-DD HH:mm:ss (YYYY-MM-DD for dates) and they are considered GMT+0.
We use the shortened form PM to describe the project manager access level, and GM for group managers.
On February 2016 we renamed tasks as phases, but all phases endpoints and parameters still use the task term (same thing for task categories which are now called phase categories).
It can be a little confusing, but for the moment we will keep the reference as it is. We may create new endpoint in the future and leave the current ones a bit longer for backward compatibility.
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.
In case the limit is reached, the following requests (for the given token) will receive a 429 error with a retryAfter attribute that indicates after which datetime (GMT+0) you will be able to retry the request.
{
"code" : 429,
"description" : "Too many requests",
"retryAfter" : "2018-06-22 14:25:10"
}
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 |
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.
Every error returns also an object with the code and an optional description that can be used in debug to understand the specific case.
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. | |
| 402 | Payment required | The request was valid, but the authorizated user's workspace subscription is 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. | |
| 404 | Not found | The requested resource is not available. | |
| 409 | Conflict | The resource you're trying to create already exists. This can happen when trying to create a project with a nem already in use or a user with an email linked to an existing user. |
|
| 423 | Locked | The resource you're trying to edit is locked, and the authorized user doesn't have the access level required to edit a locked resource. | |
| 429 | Too many requests | You have reached your rate limit for the given token. The returned error message will have the attribute retryAfter with the datetime UTC+0 after which you'll be able to retry your request.See the "Rate limit" section for more info. |
|
| 500 | Internal server error | There was a problem on our side. |
Bearer| clientId | |
|---|---|
| code | The code appended in the redirectUri when Timeneye redirects back to your app after the user has authorized your app |
XXXXXXXXXXXXXXXXXXXXXXXXXX2018-06-01 15:00:00| clientId | |
|---|---|
| refreshToken |
XXXXXXXXXXXXXXXXXXXXXXXXXX2018-06-01 15:00:00Projects related Endpoints visit Timeneye Vocabulary for more information
Returns the list of projects accessible by the authenticated user.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin or GM. The authenticated user is automatically added as the PM of the project.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800| projectId | Numeric ID of the project |
|---|
Some details are returned only if the authenticated user is an Admin or PM of the given project.
25Arvo's project25AxionThe hourly Price. Visible by PM only.
20.6360Indicates the project's total spent minutes.
120Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin or PM of the given project.
The name of the project, if edited.
The project's new hourly rate
The name of the project, if edited.
The project's new hourly rate
The name of the project, if edited.
The project's new hourly rate
The name of the project, if edited.
The project's new hourly rate
The name of the project, if edited.
The project's new hourly rate
The name of the project, if edited.
The project's new hourly rate
The name of the project, if edited.
The project's new hourly rate
The name of the project, if edited.
The project's new hourly rate
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800The name of the project, if edited.
The project's new hourly rate
This endpoint is available only if the authenticated user is an Admin. This action is irreversible and will delete permanently also all entries and timers linked to the given project.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800| projectId | The Project Id |
|---|
This endpoint is available only if the authenticated user is an Admin or PM of the given project.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin or PM of the given project.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800| projectId | The Project Id |
|---|---|
| userId | The User Id |
Updates a user's data relative to the given project. This endpoint is available only if the authenticated user is an Admin or PM of the given project.
Indicate if the user should be made PM 1 or not 0 (default)
Indicate if the user should be made PM 1 or not 0 (default)
Indicate if the user should be made PM 1 or not 0 (default)
Indicate if the user should be made PM 1 or not 0 (default)
Indicate if the user should be made PM 1 or not 0 (default)
Indicate if the user should be made PM 1 or not 0 (default)
Indicate if the user should be made PM 1 or not 0 (default)
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Phases related Endpoints visit Timeneye Vocabulary for more information
| projectId | Numeric ID of the project |
|---|
Some details are returned only if the authenticated user is an Admin or PM of the given project.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin or PM of the given project.
The budget hours for the phase. It's only visible to PMs
5432The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800The budget hours for the phase. It's only visible to PMs
| projectId | Numeric ID of the project |
|---|---|
| taskId | Numeric ID of the phase |
Some details are returned only if the authenticated user is an Admin or PM of the given project.
607Phase's nameTells if the phase is either open or closed. 1 - open 0 - closed
74category nameThe budget minutes for the phase. It's only visible to PMs
120Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin or PM of the given project.
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
The budget hours for the phase. It's only visible to PMs
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800The budget hours for the phase. It's only visible to PMs
This endpoint is available only if the authenticated user is an Admin or PM of the given project. This action is irreversible and will delete permanently also all entries and timers linked to the given phase.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Users related Endpoints visit Timeneye Vocabulary for moreinformation
This endpoint is available only if the authenticated user is an Admin.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin.
Indicates if the user is an admin 1 or not 0 (default)
560Indicates if the user is an admin 1 or not 0 (default)
Indicates if the user is an admin 1 or not 0 (default)
Indicates if the user is an admin 1 or not 0 (default)
Indicates if the user is an admin 1 or not 0 (default)
Indicates if the user is an admin 1 or not 0 (default)
Indicates if the user is an admin 1 or not 0 (default)
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Indicates if the user is an admin 1 or not 0 (default)
| userId | Unique user identifier |
|---|
This endpoint is available only if the authenticated user is an Admin.
5740Arvoarvo@timeneye.comTimestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin. This action is irreversible and will delete permanently also all entries and timers linked to the given user.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800| userId | The user identification number ID |
|---|
This endpoint is available only if the authenticated user is an Admin.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin.
| userId | The user identification number ID |
|---|---|
| projectId | The Project identification number ID |
This endpoint is available only if the authenticated user is an Admin or PM of the given project.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800This endpoint is available only if the authenticated user is an Admin.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Entries related Endpoints visit Timeneye Vocabulary for moreinformation
| dateFrom | Start date. If empty default is one week ago. |
|---|---|
| dateTo | End date |
| projectId | Unique project identifier |
| taskId | Unique phase identifier |
| taskCategoryId | Unique phase Category Id identifier |
| userId | Unique user identifier |
| limit | Limit the number of entries to get. |
| offset | An offset to start from. Number of entries to skip |
| clientId | Filter the entries based on a project id. If set to -2 it will filter for entries without a client |
| billed | It filters entries based on the billed status. It accepts 3 values. 0 for billable entries 1 for billed entries 2 for entries which are not billable (parent project not billable) |
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800If you want to create an entry with a different user than the authenticated one, the latter needs to be an Admin.
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
| entryId | Unique entry identifier |
|---|
If you want to edit an entry with a different user than the authenticated one, the latter needs to be an Admin or PM of the entry's project.
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Unique user identifier, default the current authenticated user
When the entry was created. default today (UTC)
json encode of the tag ids' list
If you want to delete an entry with a different user than the authenticated one, the latter needs to be an Admin or PM of the entry's project.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Timers related Endpoints visit Timeneye Vocabulary for moreinformation
Returns the authenticated users's timers.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Starts a new timer for the authenticated user.
json encode of the tag ids' list
1768json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800json encode of the tag ids' list
| timerId |
|---|
Only timers of the authenticated user can be edited.
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
json encode of the tag ids' list
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800json encode of the tag ids' list
Only timers of the authenticated user can be deleted.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Stops (if running) a timer and stores it as an entry.
Only timers of the authenticated user can be saved.
637Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Clients related Endpoints visit Timeneye Vocabulary for moreinformation
Returns the list of clients in the authenticated user workspace. This endpoint is available only if the authenticated user is an Admin.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Phase categories related Endpoints visit Timeneye Vocabulary for more information
Returns the list of phase categories in the authenticated user workspace. This endpoint is available only if the authenticated user is an Admin.
Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes)
1514800800Returns the list of tag lists in the authenticated user workspace.
| tagListId |
|---|
Returns the given tag list in the authenticated user workspace.
25Arvo's project25AxionThe hourly Price. Visible by PM only.
20.6360Indicates the project's total spent minutes.
120607Phase's nameTells if the phase is either open or closed. 1 - open 0 - closed
74category nameThe budget minutes for the phase. It's only visible to PMs
120127arvoThe total Time budget (in minutes) assigned to the user. It's only visible to PMs
120162013-01-31260Arvo's project180Arvo197Define variables namescamelCase or snake_case?48017axionMy Category name10