Api Reference · Apiary

{"mock":"https://private-anon-3444d2a987-timeneye.apiary-mock.com/","production":"https://track.timeneye.com/","proxy":"https://private-anon-3444d2a987-timeneye.apiary-proxy.com/"}

swagger: '2.0' info: version: '11' title: Api Reference description: | #Overview 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](https://track.timeneye.com/developers). 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`. At this point to get the access token just call the [Get token](#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](#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. #Useful information ## Endpoints base url and protocol All our API endpoints have as baseurl `https://track.timeneye.com/api/3` and all calls must be performed via `https`. **CORS is supported.** ## Dates and datetimes 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`. ## What PM and GM means? We use the shortened form `PM` to describe the **project manager** access level, and `GM` for **group managers**. ## Task And task categories 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. #Rate limits 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. <table> <tr> <td>Plan</td> <td>Maximum requests per 5 minutes</td> </tr> <tr> <td>Free</td> <td>500</td> </tr> <tr> <td>Business (any tier)/PRO</td> <td>2000</td> </tr> </table> #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. 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. <table> <tr> <td>Code</td> <td>Meaning</td> <td>Description</td> </tr> <tr> <td>400</td> <td>Bad request</td> <td>One or multiple required parameters are missing or invalid.</td> </tr> <tr> <td>401</td> <td>Unauthorized</td> <td>The authorization token is missing, invalid or expired.</td> </tr> <tr> <td>402</td> <td>Payment required</td> <td>The request was valid, but the authorizated user's workspace subscription is expired.<td> </tr> <tr> <td>403</td> <td>Forbidden</td> <td>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.</td> </tr> <tr> <td>404</td> <td>Not found</td> <td>The requested resource is not available.</td> </tr> <tr> <td>409</td> <td>Conflict</td> <td>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.</td> </tr> <tr> <td>423</td> <td>Locked</td> <td>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.</td> </tr> <tr> <td>429</td> <td>Too many requests</td> <td>You have reached your rate limit for the given token. The returned error message will have the attribute <code>retryAfter</code> with the datetime UTC+0 after which you'll be able to retry your request. See the "Rate limit" section for more info.</td> </tr> <tr> <td>500</td> <td>Internal server error</td> <td>There was a problem on our side.</td> </tr> </table> termsOfService: 'https://www.timeneye.com/terms-and-conditions' contact: name: Timeneye url: 'https://www.timeneye.com/' email: support@timeneye.com tags: - name: Projects description: > Projects related Endpoints visit [Timeneye Vocabulary](https://guide.timeneye.com/docs/timeneye-vocabularly) for more information - name: Phases description: > Phases related Endpoints visit [Timeneye Vocabulary](https://guide.timeneye.com/docs/timeneye-vocabularly) for more information - name: Users description: > Users related Endpoints visit [Timeneye Vocabulary](https://guide.timeneye.com/docs/timeneye-vocabularly) for moreinformation - name: Entries description: > Entries related Endpoints visit [Timeneye Vocabulary](https://guide.timeneye.com/docs/timeneye-vocabularly) for moreinformation - name: Timers description: > Timers related Endpoints visit [Timeneye Vocabulary](https://guide.timeneye.com/docs/timeneye-vocabularly) for moreinformation - name: Clients description: > Clients related Endpoints visit [Timeneye Vocabulary](https://guide.timeneye.com/docs/timeneye-vocabularly) for moreinformation - name: Phase categories description: > Phase categories related Endpoints visit [Timeneye Vocabulary](https://guide.timeneye.com/docs/timeneye-vocabularly) for more information host: track.timeneye.com basePath: /api/3 schemes: - https x-samples-languages: - node - curl - ruby - javascript - python - java - php securityDefinitions: TokenKeyInHeader: type: apiKey in: header name: Bearer security: - TokenKeyInHeader: [] paths: '/token/{clientId}/{code}': parameters: - in: path name: clientId required: true type: string - in: path name: code required: true type: string description: > The code appended in the redirectUri when Timeneye redirects back to your app after the user has authorized your app get: summary: Get token tags: - Authentication produces: - application/json responses: '200': description: '' schema: type: object properties: accessToken: type: string example: "XXXXXXXXXXXXX" refreshToken: type: string example: "XXXXXXXXXXXXX" expiration: type: string example: "2018-06-01 15:00:00" '/refrsh-token/{clientId}/{refreshToken}': parameters: - in: path name: clientId required: true type: string - in: path name: refreshToken required: true type: string get: summary: Refresh token tags: - Authentication produces: - application/json responses: '200': description: '' schema: type: object properties: accessToken: type: string example: "XXXXXXXXXXXXX" refreshToken: type: string example: "XXXXXXXXXXXXX" expiration: type: string example: "2018-06-01 15:00:00" /projects: get: summary: Get projects list description: > Returns the list of projects accessible by the authenticated user. tags: - Projects produces: - application/json responses: '200': description: A list of projects schema: type: object properties: projects: type: array items: type: object properties: id: type: integer description: project unique identifier example: 125 name: type: string description: Project name example: Arvo's project isActive: type: number description: if 1 the project is used enum: - 0 - 1 example: 1 required: - id - name - isActive '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '429': $ref: '#/responses/429' post: summary: Create new project tags: - Projects consumes: - application/x-www-form-urlencoded produces: - application/json description: > This 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. parameters: - in: formData required: true name: name type: string description: Name of the new project responses: '200': description: Project created succesfully schema: type: object properties: id: type: string description: id of the newly created app. required: - id '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '409': $ref: '#/responses/409' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/projects/{projectId}': parameters: - in: path name: projectId required: true type: integer description: Numeric ID of the project get: summary: Get project's details tags: - Projects consumes: - application/json description: > Some details are returned only if the authenticated user is an Admin or PM of the given project. responses: '200': description: ok schema: $ref: '#/definitions/projectSingle' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' put: summary: Update project tags: - Projects produces: - application/json consumes: - application/x-www-form-urlencoded description: > This endpoint is available only if the authenticated user is an Admin or PM of the given project. parameters: - in: formData name: name type: string description: 'The name of the project, if edited.' - in: formData name: isBillable type: number format: integer description: Indicates if the project is billable 1 or not 0 enum: - 0 - 1 - in: formData name: hourlyRate type: number format: float description: The project's new hourly rate - in: formData name: budgetMinutes type: number format: int64 description: The project new budget in minutes responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '409': $ref: '#/responses/409' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' delete: summary: Delete project tags: - Projects description: > 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. responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/projects/{projectId}/users': parameters: - in: path name: projectId type: integer required: true description: The Project Id get: description: > This endpoint is available only if the authenticated user is an Admin or PM of the given project. summary: Get project's users list tags: - Projects produces: - application/json responses: '200': description: The list of users of the project schema: type: object properties: users: type: array items: $ref: '#/definitions/userInList' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' post: description: > This endpoint is available only if the authenticated user is an Admin or PM of the given project. summary: Add user to project tags: - Projects produces: - application/json consumes: - application/x-www-form-urlencoded parameters: - in: formData name: userId description: The User Identification Number type: integer required: true - in: formData name: isPM type: integer description: | Indicates if the user would be a PM 1 or not 0 for this project enum: - 0 - 1 - in: formData name: budgetHours type: integer description: Indicates the amount of budget time to assign to the user in hours responses: '201': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/projects/{projectId}/tasks': parameters: - in: path name: projectId type: integer required: true description: Numeric ID of the project get: summary: Get phases list tags: - Phases description: > Some details are returned only if the authenticated user is an Admin or PM of the given project. responses: '200': description: A list of projects schema: type: object properties: projects: type: array items: $ref: '#/definitions/task' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '429': $ref: '#/responses/429' post: summary: Create new phase description: > This endpoint is available only if the authenticated user is an Admin or PM of the given project. tags: - Phases produces: - aplication/json consumes: - application/x-www-form-urlencoded parameters: - in: formData name: name type: string description: The name of the phase - in: formData name: categoryId type: integer description: The id of the phase category. - in: formData name: budgetHours type: integer description: The budget hours for the phase. It's only visible to PMs responses: '201': description: Unique task identifier schema: type: object properties: id: type: integer example: 5432 description: The id of the newly created phase '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '409': $ref: '#/responses/409' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/projects/{projectId}/tasks/{taskId}': parameters: - in: path name: projectId type: integer required: true description: Numeric ID of the project - in: path name: taskId type: integer required: true description: Numeric ID of the phase get: summary: Get phase details description: > Some details are returned only if the authenticated user is an Admin or PM of the given project. tags: - Phases produces: - application/json responses: '200': description: 'Returns a phase details, some are visible to PMs and Admins only' schema: $ref: '#/definitions/task' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' put: summary: Update phase description: > This endpoint is available only if the authenticated user is an Admin or PM of the given project. tags: - Phases produces: - application/json consumes: - application/x-www-form-urlencoded parameters: - in: formData name: name type: string description: The name of the phase required: true - in: formData name: categoryId type: integer description: The id of the phase category. - in: formData name: budgetHours type: integer description: The budget hours for the phase. It's only visible to PMs responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' delete: summary: Delete phase description: > 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. tags: - Phases produces: - application/json responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/projects/{projectId}/users/{userId}': parameters: - in: path name: projectId type: integer required: true description: The Project Id - in: path name: userId type: integer required: true description: The User Id put: summary: Update project's user description: > 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. tags: - Projects produces: - application/json consumes: - application/x-www-form-urlencoded parameters: - in: formData name: budgetHours type: integer description: The number of hours to set in the hours budget - in: formData name: isPM type: number description: Indicate if the user should be made PM 1 or not 0 (default) enum: - 0 - 1 responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' delete: summary: Remove user from project description: > This endpoint is available only if the authenticated user is an Admin. tags: - Projects produces: - application/json responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' /users: get: summary: Get users list tags: - Users description: > This endpoint is available only if the authenticated user is an Admin. responses: '200': description: | Returns the list of users in the authenticated user workspace. schema: type: object properties: users: type: array items: type: object properties: id: type: integer description: Unique user identifier example: 5478 name: type: string description: User name example: Arvo email: type: string description: User email example: arvo@timeneye.com enabled: type: integer description: | Indicate if the user is enabled or deactivated Returns 1 for true and 0 for false enum: - 0 - 1 example: 1 isAdmin: type: integer description: | Indicates if the user is an admin 1 or not 0 enum: - 0 - 1 example: 1 '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '429': $ref: '#/responses/429' post: summary: Create user tags: - Users consumes: - application/x-www-form-urlencoded produces: - application/json description: > This endpoint is available only if the authenticated user is an Admin. parameters: - in: formData name: email type: string description: User email format: email required: true - in: formData name: name type: string description: User name required: true - in: formData name: isAdmin type: number description: Indicates if the user is an admin 1 or not 0 (default) enum: - 0 - 1 responses: '201': description: Retuns the id of the newly created user. schema: type: object properties: id: type: integer description: Unique user identifier example: 560 '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '406': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/users/{userId}': parameters: - in: path name: userId type: integer required: true description: Unique user identifier get: summary: Get user's details description: > This endpoint is available only if the authenticated user is an Admin. tags: - Users produces: - application/json responses: '200': description: User details schema: type: object properties: id: type: integer description: Unique user identifier example: 5740 name: type: string description: User name example: Arvo email: type: string description: User email example: arvo@timeneye.com enabled: type: integer description: | Indicate if the user is enabled 1 or deactivated 0 enum: - 0 - 1 example: 1 isAdmin: type: integer description: | Indicates if the user is an admin 1 or not 0 enum: - 0 - 1 example: 1 '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' put: summary: Update user description: > This endpoint is available only if the authenticated user is an Admin. tags: - Users consumes: - application/x-www-form-urlencoded parameters: - in: formData name: name type: string description: User name - in: formData name: email type: string description: User email - in: formData name: isAdmin type: number description: Indicates if the user is an admin 1 or not 0 enum: - 0 - 1 responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '404': $ref: '#/responses/404' '409': $ref: '#/responses/409' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' delete: summary: Delete user description: > 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 user. tags: - Users responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/users/{userId}/projects': parameters: - in: path name: userId type: integer required: true description: The user identification number ID get: summary: Get user's projects description: > This endpoint is available only if the authenticated user is an Admin. tags: - Users responses: '200': description: Returns an array of user projects. schema: type: object properties: projects: type: array items: type: object properties: id: type: integer description: Unique project identifier example: 570 name: type: string description: Project name example: Arvo isPM: type: number description: Indicates if the user is a PM 1 or not 0 enum: - 0 - 1 example: 1 budgetMinutes: type: integer description: The available minutes budget example: 60 '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' post: summary: Add user to project description: > This endpoint is available only if the authenticated user is an Admin. tags: - Users consumes: - application/x-www-form-urlencoded parameters: - in: formData name: projectId type: integer description: Unique project identifier - in: formData name: isPM type: integer description: Indicates if the user is a PM 1 or not 0 enum: - 0 - 1 - in: formData name: budgetHours type: integer description: The number of hours assigned to the user for this project responses: '201': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '500': $ref: '#/responses/500' '/users/{userId}/projects/{projectId}': parameters: - in: path name: userId type: integer required: true description: The user identification number ID - in: path name: projectId type: integer required: true description: The Project identification number ID put: summary: Update user's project description: > This endpoint is available only if the authenticated user is an Admin or PM of the given project. tags: - Users consumes: - application/x-www-form-urlencoded parameters: - in: formData name: budgetHours type: integer description: The Total number of hours assigned to the user - in: formData name: isPM type: integer description: Indicates if the user is ether PM 1 or not 0 enum: - 0 - 1 responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' delete: summary: Remove user description: > This endpoint is available only if the authenticated user is an Admin. tags: - Users responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' /entries: get: summary: Get entries list description: '' tags: - Entries parameters: - in: query name: dateFrom type: string format: date description: Start date. If empty default is one week ago. - in: query name: dateTo type: string format: date description: End date - in: query name: projectId type: integer description: Unique project identifier - in: query name: taskId type: integer description: Unique phase identifier - in: query name: taskCategoryId type: integer description: Unique phase Category Id identifier - in: query name: userId type: integer description: Unique user identifier - in: query name: limit type: integer description: Limit the number of entries to get. - in: query name: offset type: integer description: An offset to start from. Number of entries to skip - in: query name: clientId type: integer description: | Filter the entries based on a project id. If set to -2 it will filter for entries without a client - in: query name: billed type: integer description: > 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) enum: - 0 - 1 - 2 responses: '200': description: A list of entries schema: type: object properties: entries: type: array items: $ref: '#/definitions/entryInList' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '429': $ref: '#/responses/429' post: summary: Create a new entry description: > If you want to create an entry with a different user than the authenticated one, the latter needs to be an Admin. tags: - Entries consumes: - application/x-www-form-urlencoded parameters: - in: formData name: projectId type: integer description: The project ID where the entry will be created required: true - in: formData name: taskId type: integer description: The phase ID where the entry will be created required: true - in: formData name: minutes type: integer description: entry minutes required: true - in: formData name: userId type: integer description: 'Unique user identifier, default the current **authenticated user**' - in: formData name: entryDate type: string description: When the entry was created. default today (UTC) - in: formData name: notes type: string description: Some additional information or notes about the entry - in: formData name: taskCategoryId type: integer description: Unique phase Category Id identifier responses: '200': description: entry created. returns the id of the new entry. schema: type: object properties: id: type: integer description: Unique entry identifier '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '423': $ref: '#/responses/423' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/entries/{entryId}': parameters: - in: path name: entryId description: Unique entry identifier type: integer required: true put: summary: Update entry description: > 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. tags: - Entries consumes: - application/x-www-form-urlencoded parameters: - in: formData name: projectId type: integer description: The project ID - in: formData name: taskId type: integer description: The phase ID - in: formData name: minutes type: integer description: entry minutes - in: formData name: userId type: integer description: | Unique user identifier, default the current **authenticated user** - in: formData name: entryDate type: string description: When the entry was created. default today (UTC) - in: formData name: notes type: string description: Some additional information or notes about the entry responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '423': $ref: '#/responses/423' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' delete: summary: Delete entry description: > 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. tags: - Entries responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '423': $ref: '#/responses/423' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' /timers: get: summary: Get timers list description: | Returns the authenticated users's timers. tags: - Timers responses: '200': description: An array containing user's timers. schema: type: object properties: timers: type: array items: type: object properties: id: type: integer description: unique timer identifier example: 15 projectId: type: integer description: unique project identifier example: 25 projectName: type: string description: project name example: Arvo's project taskId: type: integer description: unique phase identifier example: 4 taskName: type: string description: phase name example: Find a variable name notes: type: string description: Some additional information or notes about the timer example: camelCase or snake_case ? timerStatus: type: string description: 'Possible values: running or paused' enum: - running - paused example: running currentSeconds: type: integer description: timer's current seconds count as for now example: 28800 updatedDatetime: type: string description: 'last updated time. format ''Y-m-d H:i:s''' example: '2017-11-15 12:56:37' timerDate: type: string description: timer's date example: '2017-11-15' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '429': $ref: '#/responses/429' post: summary: Start timer description: | Starts a new timer for the authenticated user. tags: - Timers consumes: - application/x-www-form-urlencoded parameters: - in: formData name: projectId type: integer description: unique project identifier required: true - in: formData name: taskId type: integer required: true description: unique phase identifier - in: formData name: seconds type: integer description: The seconds already counted. - in: formData name: notes type: string description: Some additional information or notes about the timer responses: '201': description: Returns the id of the new entry schema: type: object properties: id: type: integer example: 1768 '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '423': $ref: '#/responses/423' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' '/timers/{timerId}': parameters: - in: path required: true name: timerId type: integer put: summary: Update a timer description: | Only timers of the authenticated user can be edited. tags: - Timers consumes: - application/x-www-form-urlencoded parameters: - in: formData name: projectId type: integer description: unique project identifier - in: formData name: taskId type: integer description: unique phase identifier - in: formData name: seconds type: integer description: The seconds to count - in: formData name: notes type: string description: Some additional information or notes about the timer - in: formData name: timerDate type: string description: The timer date responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' delete: summary: Delete timer description: | Only timers of the authenticated user can be deleted. tags: - Timers responses: '200': description: 'Action performed, returns an empty response' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' post: summary: Save timer as an entry description: | Stops (if running) a timer and stores it as an entry. Only timers of the authenticated user can be saved. tags: - Timers responses: '200': description: Returns the id of the newly created entry schema: type: object properties: id: type: integer description: unique entry identifier example: 637 '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '423': $ref: '#/responses/423' '429': $ref: '#/responses/429' '500': $ref: '#/responses/500' /clients: get: summary: Get client list description: > Returns the list of clients in the authenticated user workspace. This endpoint is available only if the authenticated user is an Admin. tags: - Clients responses: '200': description: An array containing the list of clients schema: type: object properties: clients: type: array items: type: object properties: id: type: integer description: unique client identifier example: 25 name: type: string description: client name example: Axion '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '429': $ref: '#/responses/429' /taskcategories: get: summary: Get phase categories list description: > Returns the list of phase categories in the authenticated user workspace. This endpoint is available only if the authenticated user is an Admin. tags: - Phase categories responses: '200': description: An array of phase categories schema: type: object properties: categories: type: array items: type: object properties: id: type: integer description: unique category identifier example: 12 name: type: string description: category name example: Arvo's Phase Category '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '402': $ref: '#/responses/402' '403': $ref: '#/responses/403' '429': $ref: '#/responses/429' definitions: projectSingle: type: object required: - id - name - isActive properties: id: type: integer description: project unique identifier example: 25 name: type: string description: Project name example: Arvo's project isActive: type: integer description: tells if the project is active 1 or not 0 example: 0 enum: - 1 - 0 clientId: type: integer description: Visible by PMs only example: 25 clientName: type: string description: Client name. Visible by PMs only example: Axion isBillable: type: integer description: Indicate if the project is ether Billable 1 or not 0 enum: - 0 - 1 example: 1 hourlyRate: type: number format: float description: The hourly Price. Visible by PM only. example: 20.6 budgetMinutes: type: integer description: Indicates the project budget mintes example: 360 totalMinutes: type: integer description: Indicates the project's total spent minutes. example: 120 task: type: object required: - id - name - isOpen - categoryId - categoryName properties: id: type: integer description: The unique identifier of the phase. example: 607 name: type: string description: The name of the phase example: Phase's name isOpen: type: integer enum: - 0 - 1 description: Tells if the phase is either open or closed. 1 - open 0 - closed example: 1 categoryId: type: integer description: The id of the phase category. example: 74 categoryName: type: string description: The name of the category example: category name budgetMinutes: type: integer description: The budget minutes for the phase. It's only visible to PMs example: 120 error: type: object properties: code: type: string description: type: string required: - description - code userInList: type: object required: - id - name - isPM properties: id: type: integer description: Unique user identifier example: 127 name: type: string description: The Name of the user example: arvo isPM: type: integer enum: - 0 - 1 description: If 1 the user is a PM of this project example: 1 budgetMinutes: type: string description: |- The total Time budget (in minutes) assigned to the user. It's only visible to PMs example: 120 entryInList: type: object properties: id: type: integer description: Unique entry identifier example: 16 entryDate: type: string description: Date the entry was created on example: '2013-01-31' projectId: type: integer description: Unique project identifier example: 260 projectName: type: string description: Project name example: Arvo's project userId: type: integer description: Unique user identifier example: 180 userName: type: string description: User name example: Arvo taskId: type: integer description: Unique phase identifier example: 197 taskName: type: string description: phase name example: Define variables names notes: type: string description: Notes example: camelCase or snake_case? minutes: type: integer description: The entrie duration in Minutes example: 480 billed: type: integer description: Indicates if the Entry has been billed 1 or not 0 enum: - 0 - 1 example: 1 locked: type: number description: Indicates if the Entry is locked 1 or not 0 enum: - 0 - 1 example: 1 clientId: type: integer description: The unique identification name of the client example: 17 clientName: type: string description: The name of the client example: axion taskCategoryName: type: string description: The name of the task category example: My Category name taskCategoryId: type: integer description: Unique phase Category Id identifier example: 10 authorizationObject: type: object properties: accessToken: type: string refreshToken: type: string expiration: type: string responses: '400': description: 'Bad Request: missing required parameters' schema: $ref: '#/definitions/error' '401': description: 'Unauthorized: authToken not valid' schema: $ref: '#/definitions/error' '402': description: Workspace subscription expired schema: $ref: '#/definitions/error' '403': description: Not permitted schema: $ref: '#/definitions/error' '404': description: Not Found schema: $ref: '#/definitions/error' '407': description: Invalid or missing data schema: $ref: '#/definitions/error' '409': description: 'Conflict, the requested new entity already exists' schema: $ref: '#/definitions/error' '423': description: >- The entity you're trying to edit is locked (and the authenticated user doesn't have the access level needed to edit this locked entity) schema: $ref: '#/definitions/error' '429': description: Too many requests. schema: type: object properties: code: type: string description: Error code description: type: string description: The error message nextRefresh: type: integer description: |- Timestamp (in seconds) of when the current limits will be refreshed (generealy once per 5 minutes) example: 1514800800 '500': description: Failed schema: $ref: '#/definitions/error'