Introduction
Welcome! This document provides a full list of all Timely APIs currently available, so you can start integrating Timely with your favorite applications.
Got questions? Please send them to support@timelyapp.com.
Authentication
OAuth2 Authentication: http://tools.ietf.org/html/rfc6749
Create an OAuth Application (only available to the Admin User): https://timelyapp.com/:account_id/oauth_applications
Enter your application name and the redirect_url to your application.
Acquire the Application Id and Secret.
The base URL for all API's is: https://api.timelyapp.com/1.1
Authorization
OAuth Code
Example Request: (try this in your web browser)
https://api.timelyapp.com/1.1/oauth/authorize?response_type=code
&redirect_uri=your_redirect_uri&client_id=your_client_id
Users are redirected to request their Timely identity.
HTTP Request
GET /oauth/authorize
Compulsory Parameters
| Parameter | Description |
|---|---|
| response_type | code |
| redirect_uri | http://your-redirect-url/ |
| client_id | your_application_id |
If the user accepts your request, Timely will redirect back with the code parameter, which you need to use to get the token.
OAuth Token
Example Request:
curl -X POST --data "redirect_uri=https://your-redirect_url/&code=your_response_code
&client_id=application_id&client_secret=application_secret&grant_type=authorization_code"
https://api.timelyapp.com/1.1/oauth/token
{
"access_token":"1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a",
"token_type":"bearer",
"refresh_token":"9db4d1a5d87c707b8125d8f93ad08091fb3ff8b93be901dbeaba968cf532ed9b"
}
200 OK
Users are redirected to request their Timely identity.
HTTP Request
POST /oauth/token
Compulsory Parameters
| Parameter | Description |
|---|---|
| redirect_uri | http://your-redirect-url/ |
| code | your_response_code |
| client_id | your_application_id |
| client_secret | your_application_secret |
| grant_type | authorization_code |
The response will be a token with a refresh token. Use the token to use the following API.
Use Timely API to integrate with your apps
Timely API helps you integrate your application with Timely. Following are the list of API’s available. For any help or support email support@timelyapp.com
Accounts
List all accounts
Returns all the accounts created against one email address.
Request
curl -g "https://api.timelyapp.com/1.1/accounts" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ddG5xwnq1WpOP3_9imU793bYQ-MFGn_5UxqhZHMFxDE" \
-H "Cookie: "
Endpoint
GET /1.1/accounts
GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer ddG5xwnq1WpOP3_9imU793bYQ-MFGn_5UxqhZHMFxDE
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 14,
"name": "Timely",
"color": "44505e",
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"logo": {
"large_retina": "/assets/account_thumbs/account_large_retina-9aefd4c1fb903fb750d36f1b1cc64dc01eb578efd2fd0eb5311344082d6d036e.png",
"medium_retina": "/assets/account_thumbs/account_medium_retina-3e55e5ac5ba6b1d8077c1e329691e55032a5831997c9e712998594192d534fdf.png",
"small_retina": "/assets/account_thumbs/account_small_retina-1b8bfb705765064d856161ba9daa1d52155f181c330ac6fe9b5e2f366adaf4fe.png",
"brand_logo": false
},
"from": "Web",
"max_users": 0,
"seats": 1,
"num_users": 1,
"max_projects": 0,
"num_projects": 0,
"plan_id": 14,
"plan_name": "Essential",
"next_charge": "2020-07-03",
"start_of_week": 0,
"created_at": 1591172180,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 34,
"weekly_user_capacity": 40.0,
"default_hour_rate": 0.0,
"capacity": {
"hours": 40.0,
"minutes": 0.0,
"seconds": 0.0,
"formatted": "40:00",
"total_hours": 40.0,
"total_seconds": 144000.0,
"total_minutes": 2400.0
},
"status": "active",
"beta": false,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "control",
"days": -1
},
{
"name": "memories",
"days": -1
},
{
"name": "billing",
"days": -1
},
{
"name": "project_required_fields",
"days": -1
},
{
"name": "teams",
"days": -1
},
{
"name": "recurring_budget",
"days": -1
},
{
"name": "notifications_project_budget",
"days": -1
},
{
"name": "weekly_user_capacity",
"days": -1
},
{
"name": "company_view",
"days": -1
},
{
"name": "anomalies",
"days": -1
},
{
"name": "log_hours_for_others",
"days": -1
},
{
"name": "project_budget",
"days": -1
},
{
"name": "budgets_hourly_rates",
"days": -1
},
{
"name": "account_branding",
"days": -1
},
{
"name": "team_lead",
"days": -1
},
{
"name": "ai_timesheet_creation",
"days": -1
},
{
"name": "in_app_support",
"days": -1
},
{
"name": "planning",
"days": -1
},
{
"name": "people_dashboard",
"days": -1
},
{
"name": "people_notify",
"days": -1
}
]
}
]
Retrieve activities
This endpoint shows you all activities tied to you and/or any other users you have permission to view. Activities include: logged hours, created a report, shared a report.
Request
curl -g "https://api.timelyapp.com/1.1/12/activities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Vk_RiIYV5Gmj8UdIUUAdvzW9e34MAfu3Cw-O24gse_k" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/activities
GET /1.1/12/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer Vk_RiIYV5Gmj8UdIUUAdvzW9e34MAfu3Cw-O24gse_k
Parameters
| Name | Description |
|---|---|
| account_id | The ID of the account you want to retrieve |
| limit | Retrieve a limited number of activities |
| offset | Retrieve activities from offset |
| order | Sorting order on created_at |
| filter | Filter activities by entity_type - Ex: filter=projects |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 19,
"user": {
"id": 29,
"email": "marijantmaegws@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:19+02:00"
},
"message": "archived",
"activity_type": "archive_project",
"url": "http://app.timelyapp.local:3002/12/projects/9",
"updated_at": "2020-05-27T10:16:19+02:00",
"detail": null,
"associated_ids": [
],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 9,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 9,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:19+02:00"
},
"updated_at": "2020-06-03T10:16:19+02:00"
},
"anomaly": false
},
{
"id": 18,
"user": {
"id": 29,
"email": "marijantmaegws@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/96b22c9a4dee53802516410c605c8048?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:19+02:00"
},
"message": "50% of budget used",
"activity_type": "project_budget_progress_fifty",
"url": "http://app.timelyapp.local:3002/12/projects/9",
"updated_at": "2020-06-03T10:16:19+02:00",
"detail": null,
"associated_ids": [
],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 9,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 9,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:19+02:00"
},
"updated_at": "2020-06-03T10:16:19+02:00"
},
"anomaly": false
}
]
Retrieve an account
Returns one account object related to one company and one subscription plan.
Request
curl -g "https://api.timelyapp.com/1.1/accounts/13" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer NiyonrBOcB6kEH9nOhIyA78XVHGyx3FcRjy53fA7Rg8" \
-H "Cookie: "
Endpoint
GET /1.1/accounts/:id
GET /1.1/accounts/13
Accept: application/json
Content-Type: application/json
Authorization: Bearer NiyonrBOcB6kEH9nOhIyA78XVHGyx3FcRjy53fA7Rg8
Parameters
| Name | Description |
|---|---|
| id | The id of the account to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 13,
"name": "Timely",
"color": "44505e",
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"logo": {
"large_retina": "/assets/account_thumbs/account_large_retina-9aefd4c1fb903fb750d36f1b1cc64dc01eb578efd2fd0eb5311344082d6d036e.png",
"medium_retina": "/assets/account_thumbs/account_medium_retina-3e55e5ac5ba6b1d8077c1e329691e55032a5831997c9e712998594192d534fdf.png",
"small_retina": "/assets/account_thumbs/account_small_retina-1b8bfb705765064d856161ba9daa1d52155f181c330ac6fe9b5e2f366adaf4fe.png",
"brand_logo": false
},
"from": "Web",
"max_users": 0,
"seats": 1,
"num_users": 1,
"max_projects": 0,
"num_projects": 0,
"plan_id": 13,
"plan_name": "Essential",
"next_charge": "2020-07-03",
"start_of_week": 0,
"created_at": 1591172179,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 32,
"weekly_user_capacity": 40.0,
"default_hour_rate": 0.0,
"capacity": {
"hours": 40.0,
"minutes": 0.0,
"seconds": 0.0,
"formatted": "40:00",
"total_hours": 40.0,
"total_seconds": 144000.0,
"total_minutes": 2400.0
},
"status": "active",
"beta": false,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "control",
"days": -1
},
{
"name": "memories",
"days": -1
},
{
"name": "billing",
"days": -1
},
{
"name": "project_required_fields",
"days": -1
},
{
"name": "teams",
"days": -1
},
{
"name": "recurring_budget",
"days": -1
},
{
"name": "notifications_project_budget",
"days": -1
},
{
"name": "weekly_user_capacity",
"days": -1
},
{
"name": "company_view",
"days": -1
},
{
"name": "anomalies",
"days": -1
},
{
"name": "log_hours_for_others",
"days": -1
},
{
"name": "project_budget",
"days": -1
},
{
"name": "budgets_hourly_rates",
"days": -1
},
{
"name": "account_branding",
"days": -1
},
{
"name": "team_lead",
"days": -1
},
{
"name": "ai_timesheet_creation",
"days": -1
},
{
"name": "in_app_support",
"days": -1
},
{
"name": "planning",
"days": -1
},
{
"name": "people_dashboard",
"days": -1
},
{
"name": "people_notify",
"days": -1
}
]
}
Clients
Clients are the companies that you work for. An account can have multiple clients.
Create a client
This API lets you create a client for an account.
Request
curl "https://api.timelyapp.com/1.1/36/clients" -d '{"client":{"name":"Timely","active":true,"external_id":null}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer XI3H6yXlWi7Hb9qkMRuyleCaPznpqTRBbaG1JWwbMCM" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/clients
POST /1.1/36/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer XI3H6yXlWi7Hb9qkMRuyleCaPznpqTRBbaG1JWwbMCM
Parameters
{"client":{"name":"Timely","active":true,"external_id":null}}
| Name | Description |
|---|---|
| name required | Specifies the client name |
| active | Example values: "true" or "false". Using "false" changes the client state to "archived" |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 25,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:29+02:00"
}
List all clients
Client lists will return your 10 most recently updated clients. Additionally, you can add the “per_page”, “filter” and “order” optional parameters to change the result
NOTE: Client list will return recently updated 10 clients.
Request
curl -g "https://api.timelyapp.com/1.1/37/clients" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer J4R_Yw2uH5vcnGi61C-QJ2fvHTLHXxC4lOEgovmqLR0" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients
GET /1.1/37/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer J4R_Yw2uH5vcnGi61C-QJ2fvHTLHXxC4lOEgovmqLR0
Parameters
| Name | Description |
|---|---|
| account_id | Account ID for the clients you want to retrieve |
| offset | Retrieve clients from offset |
| limit | Retrieve number of clients |
| show | Specifies which records to retrieve. The default shows a current account’s active clients (show=active). Example: "show=all" or "show=active" or "show=archived" |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 26,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:30+02:00"
}
]
Update a client
Update client details just by using a client’s ID.
Request
curl "https://api.timelyapp.com/1.1/38/clients/27" -d '{"client":{"name":"Updated name","active":true}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer GComanMMyDONQN8E9BeYtCb1-m2EDWbRyGCJju_uIcs" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/clients/:id
PUT /1.1/38/clients/27
Accept: application/json
Content-Type: application/json
Authorization: Bearer GComanMMyDONQN8E9BeYtCb1-m2EDWbRyGCJju_uIcs
Parameters
{"client":{"name":"Updated name","active":true}}
| Name | Description |
|---|---|
| id required | Client ID |
| name required | Specifies the client name |
| active | Example values: “true” or “false”. Using “false” changes the client state to “archived” |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 27,
"name": "Updated name",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:30+02:00"
}
Events
Events are all the entries a user makes. Users can add, delete and edit all entries. Some user’s actions are restricted based on their access level in Timely.
Create an event
When a user creates an event on their own timesheet.
Note: By default, the event is created for a user’s first active project, or the project they last logged time to.
Request
curl "https://api.timelyapp.com/1.1/55/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2020-06-03T10:16:36.141+02:00","to":"2020-06-03T13:46:36.141+02:00","day":"2020-06-03","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":32}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer HqiUuDxPo4oJoLSGJlBW0QCfKs7e0zz8zuLM1ujsL_I" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/events
POST /1.1/55/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer HqiUuDxPo4oJoLSGJlBW0QCfKs7e0zz8zuLM1ujsL_I
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2020-06-03T10:16:36.141+02:00","to":"2020-06-03T13:46:36.141+02:00","day":"2020-06-03","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":32}}
| Name | Description |
|---|---|
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| estimated_minutes | Specifies estimated minutes for an event. Example values: 0-60 |
| estimated_hours | Specifies estimated hours for an event. Example values: 0-12 |
| note | Specifies notes for an event |
| from | Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies label IDs for an event. Example values: label_ids:[2,3,4] |
| project_id | Specifies the project ID for an event |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 78,
"uid": "35f4a8d465e6e1edc05f3d8ab658c551",
"user": {
"id": 121,
"email": "marijaymdxcdsy@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/19bbcc2818a9877893e7670e012c0b83?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/19bbcc2818a9877893e7670e012c0b83?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/19bbcc2818a9877893e7670e012c0b83?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/19bbcc2818a9877893e7670e012c0b83?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/19bbcc2818a9877893e7670e012c0b83?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:35+02:00"
},
"project": {
"id": 32,
"active": true,
"account_id": 55,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172196,
"external_id": null,
"budget_scope": null,
"client": {
"id": 33,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:36+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172196,
"created_at": 1591172196,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:36+02:00",
"from": "2020-06-03T10:16:36+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 121,
"updater_id": 121,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Create an event for a project
Note: Normal user can add hours to existing projects from account. Limited user can add hours to only his projects.
Request
curl "https://api.timelyapp.com/1.1/54/projects/31/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2020-06-03T10:16:35.688+02:00","to":"2020-06-03T13:46:35.688+02:00","day":"2020-06-03","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":31}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer v9fw_yom6zsRZuCYHqMj2C9sQ6nXI1wzkbZ6Q-0me6Q" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects/:project_id/events
POST /1.1/54/projects/31/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer v9fw_yom6zsRZuCYHqMj2C9sQ6nXI1wzkbZ6Q-0me6Q
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2020-06-03T10:16:35.688+02:00","to":"2020-06-03T13:46:35.688+02:00","day":"2020-06-03","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":31}}
| Name | Description |
|---|---|
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| project_id required | The numerical ID of the desired project. Example values: 123 |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 77,
"uid": "28dd2c7955ce926456240b2ff0100bde",
"user": {
"id": 119,
"email": "marijadrxuuwsa@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/11d828ac0a4353381bfe39dd7d209a4b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/11d828ac0a4353381bfe39dd7d209a4b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/11d828ac0a4353381bfe39dd7d209a4b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/11d828ac0a4353381bfe39dd7d209a4b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/11d828ac0a4353381bfe39dd7d209a4b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:35+02:00"
},
"project": {
"id": 31,
"active": true,
"account_id": 54,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172195,
"external_id": null,
"budget_scope": null,
"client": {
"id": 32,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:35+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172195,
"created_at": 1591172195,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:35+02:00",
"from": "2020-06-03T10:16:35+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 119,
"updater_id": 119,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Create an event for another user
Note: Normal users can add hours for any user. If a project_id is not provided, the event is created against a user’s first active project, or the project they logged an event to in the last hour.
Request
curl "https://api.timelyapp.com/1.1/53/users/117/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2020-06-03T10:16:35.176+02:00","to":"2020-06-03T13:46:35.176+02:00","day":"2020-06-03","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":117}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ql7Ebm6bouAY1CDlhYrap7fvhogtdAzPEcAdpekxodc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users/:user_id/events
POST /1.1/53/users/117/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ql7Ebm6bouAY1CDlhYrap7fvhogtdAzPEcAdpekxodc
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2020-06-03T10:16:35.176+02:00","to":"2020-06-03T13:46:35.176+02:00","day":"2020-06-03","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":117}}
| Name | Description |
|---|---|
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| user_id required | The numerical ID of the desired user. Example values: 123 |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 76,
"uid": "fbd7939d674997cdb4692d34de8633c4",
"user": {
"id": 117,
"email": "marijatpfuclqp@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/a86d7c888fd2d442c7a2a8273a45f640?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/a86d7c888fd2d442c7a2a8273a45f640?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/a86d7c888fd2d442c7a2a8273a45f640?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/a86d7c888fd2d442c7a2a8273a45f640?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/a86d7c888fd2d442c7a2a8273a45f640?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:34+02:00"
},
"project": {
"id": 30,
"active": true,
"account_id": 53,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172195,
"external_id": null,
"budget_scope": null,
"client": {
"id": 31,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:35+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172195,
"created_at": 1591172195,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:35+02:00",
"from": "2020-06-03T10:16:35+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 117,
"updater_id": 117,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Delete an event
Note: Normal users can delete events logged to other projects by other users on an account. Limited users can only delete their own events.
Request
curl "https://api.timelyapp.com/1.1/56/events/79" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer nxcmq-rlNbW_08o6QqywQKk-GnV11wXo0hqGWCFsgG4" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/events/:id
DELETE /1.1/56/events/79
Accept: application/json
Content-Type: application/json
Authorization: Bearer nxcmq-rlNbW_08o6QqywQKk-GnV11wXo0hqGWCFsgG4
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the hour you want to delete |
| id required | The ID for the hour you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all events
Get all events linked to active projects on a user’s account.
Note: If “since” and “upto” parameters are not passed, the period will default to the date of access.
Request
curl -g "https://api.timelyapp.com/1.1/58/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer aLPU4_jv03K-rs9QR5yTLFWcHyuN3TA3bNCP95npoy4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events
GET /1.1/58/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer aLPU4_jv03K-rs9QR5yTLFWcHyuN3TA3bNCP95npoy4
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the hours you want to retrieve |
| since | Specifies the start date for returned results. Example: since=2014-08-18 |
| upto | Specifies the end date for returned results. Example: upto=2014-08-24 |
| day | Specifies the day date for returned results. Example: day=2014-08-24 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 81,
"uid": "43ec517d68b6edd3015b3edc9a11367b",
"user": {
"id": 127,
"email": "marijakfrmngso@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/22ffa52e656efea5c77e371f6524273f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/22ffa52e656efea5c77e371f6524273f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/22ffa52e656efea5c77e371f6524273f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/22ffa52e656efea5c77e371f6524273f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/22ffa52e656efea5c77e371f6524273f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:37+02:00"
},
"project": {
"id": 35,
"active": true,
"account_id": 58,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172197,
"external_id": null,
"budget_scope": null,
"client": {
"id": 36,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:37+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172197,
"created_at": 1591172197,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2020-06-03T13:46:37+02:00",
"from": "2020-06-03T10:16:37+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
]
List all events for a project
Note: Normal users can access events logged to all projects on an account. Limited users can only access events in projects they belong to.
Request
curl -g "https://api.timelyapp.com/1.1/60/projects/37/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer -f953j6eJO3Ilmul4brR6HmeKCZV8BhB-t8a94aE7zM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:project_id/events
GET /1.1/60/projects/37/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer -f953j6eJO3Ilmul4brR6HmeKCZV8BhB-t8a94aE7zM
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the hours you want to retrieve |
| project_id | The project ID for the hours you want to retrieve |
| since | Specifies the start date for returned results. Example: since=2014-08-18 |
| upto | Specifies the end date for returned results. Example: upto=2014-08-24 |
| day | Specifies the day date for returned results. Example: day=2014-08-24 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 83,
"uid": "fe9fc289c3ff0af142b6d3bead98a923",
"user": {
"id": 131,
"email": "marijawtqchstz@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/b238e695cca3a411125c810fa38a3045?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/b238e695cca3a411125c810fa38a3045?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/b238e695cca3a411125c810fa38a3045?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/b238e695cca3a411125c810fa38a3045?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/b238e695cca3a411125c810fa38a3045?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:38+02:00"
},
"project": {
"id": 37,
"active": true,
"account_id": 60,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172198,
"external_id": null,
"budget_scope": null,
"client": {
"id": 38,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:38+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172198,
"created_at": 1591172198,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2020-06-03T13:46:38+02:00",
"from": "2020-06-03T10:16:38+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
]
List all events for a user
Note: Normal users can access events logged by other users on an account. Limited users can only access their own logged events.
Request
curl -g "https://api.timelyapp.com/1.1/59/users/129/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer xmHucUwQ4Hy6ultCDADk2qcMA2CBlXyF2gOiDXAfprk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/events
GET /1.1/59/users/129/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer xmHucUwQ4Hy6ultCDADk2qcMA2CBlXyF2gOiDXAfprk
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the hours you want to retrieve |
| user_id | The user ID for the hours you want to retrieve |
| since | Specifies the start date for returned results. Example: since=2014-08-18 |
| upto | Specifies the end date for returned results. Example: upto=2014-08-24 |
| day | Specifies the day date for returned results. Example: day=2014-08-24 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 82,
"uid": "9778d5d219c5080b9a6a17bef029331c",
"user": {
"id": 129,
"email": "marijahwtaxsdm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/746278226c192b7a4f5981e384dfc540?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/746278226c192b7a4f5981e384dfc540?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/746278226c192b7a4f5981e384dfc540?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/746278226c192b7a4f5981e384dfc540?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/746278226c192b7a4f5981e384dfc540?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:37+02:00"
},
"project": {
"id": 36,
"active": true,
"account_id": 59,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172198,
"external_id": null,
"budget_scope": null,
"client": {
"id": 37,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:38+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172198,
"created_at": 1591172198,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2020-06-03T13:46:38+02:00",
"from": "2020-06-03T10:16:38+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
]
Logged in user updating details and user of an event
Note: Normal users can change an event’s creator to another user on their account. Limited users cannot edit event details.
Request
curl "https://api.timelyapp.com/1.1/65/users/141/events/88" -d '{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jWYbv_rOTu_RcqbdKdOm30oPOZnaAyH00Z9a2YpR6sI" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:user_id/events/:id
PUT /1.1/65/users/141/events/88
Accept: application/json
Content-Type: application/json
Authorization: Bearer jWYbv_rOTu_RcqbdKdOm30oPOZnaAyH00Z9a2YpR6sI
Parameters
{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
| Name | Description |
|---|---|
| id required | Event ID |
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| estimated_minutes | Specifies estimated minutes for an event. Example values: 0-60 |
| estimated_hours | Specifies estimated hours for an event. Example values: 0-12 |
| note | Specifies notes for an event |
| from | Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies label IDs for an event. Example values: label_ids:[2,3,4] |
| project_id | Specifies the project ID for an event |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 88,
"uid": "2a38a4a9316c49e5a833517c45d31070",
"user": {
"id": 141,
"email": "marijabqpgmlry@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/7283fc202b8aeacd75f0352506ea0b62?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/7283fc202b8aeacd75f0352506ea0b62?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/7283fc202b8aeacd75f0352506ea0b62?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/7283fc202b8aeacd75f0352506ea0b62?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/7283fc202b8aeacd75f0352506ea0b62?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:40+02:00"
},
"project": {
"id": 42,
"active": true,
"account_id": 65,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172200,
"external_id": null,
"budget_scope": null,
"client": {
"id": 43,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:40+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Updated details and project",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172201,
"created_at": 1591172200,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:40+02:00",
"from": "2020-06-03T10:16:40+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 141,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Loggedin user updating details and project of their event
Request
curl "https://api.timelyapp.com/1.1/64/projects/41/events/87" -d '{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer d69rYJIYpYt1wgdAsBy_dd6F6j6JLL69Y1TB37iuJZo" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:project_id/events/:id
PUT /1.1/64/projects/41/events/87
Accept: application/json
Content-Type: application/json
Authorization: Bearer d69rYJIYpYt1wgdAsBy_dd6F6j6JLL69Y1TB37iuJZo
Parameters
{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
| Name | Description |
|---|---|
| id required | Event ID |
| project_id required | Project ID |
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| estimated_minutes | Specifies estimated minutes for an event. Example values: 0-60 |
| estimated_hours | Specifies estimated hours for an event. Example values: 0-12 |
| note | Specifies notes for an event |
| from | Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies label IDs for an event. Example values: label_ids:[2,3,4] |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 87,
"uid": "c7e1249ffc03eb9ded908c236bd1996d",
"user": {
"id": 139,
"email": "marijazaqkqabc@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/d5992408f0be1778f4050863654f0e0b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/d5992408f0be1778f4050863654f0e0b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/d5992408f0be1778f4050863654f0e0b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/d5992408f0be1778f4050863654f0e0b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/d5992408f0be1778f4050863654f0e0b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:40+02:00"
},
"project": {
"id": 41,
"active": true,
"account_id": 64,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172200,
"external_id": null,
"budget_scope": null,
"client": {
"id": 42,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:40+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Updated details and project",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172200,
"created_at": 1591172200,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:40+02:00",
"from": "2020-06-03T10:16:40+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 139,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Retrieve an event
Request
curl -g "https://api.timelyapp.com/1.1/57/events/80" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer E2zFb-_Qu7nCzqiNgQNJ-rTsWnEUUPZf6leyEfo4p4s" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events/:id
GET /1.1/57/events/80
Accept: application/json
Content-Type: application/json
Authorization: Bearer E2zFb-_Qu7nCzqiNgQNJ-rTsWnEUUPZf6leyEfo4p4s
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the hour you want to retrieve |
| id | The ID of the hour you want to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 80,
"uid": "f033ab37c30201f73f142449d037028d",
"user": {
"id": 125,
"email": "marijaooqstioy@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/f786f7dba49ee3ff8028f061d608a5df?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/f786f7dba49ee3ff8028f061d608a5df?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/f786f7dba49ee3ff8028f061d608a5df?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/f786f7dba49ee3ff8028f061d608a5df?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/f786f7dba49ee3ff8028f061d608a5df?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:36+02:00"
},
"project": {
"id": 34,
"active": true,
"account_id": 57,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172197,
"external_id": null,
"budget_scope": null,
"client": {
"id": 35,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:37+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172197,
"created_at": 1591172197,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2020-06-03T13:46:37+02:00",
"from": "2020-06-03T10:16:37+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Start timer on an event
Request
curl "https://api.timelyapp.com/1.1/61/events/84/start" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer NwVIlf-CM5DYwpfu9kjcat11A7o68_7SRoab7ovTm9A" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/start
PUT /1.1/61/events/84/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer NwVIlf-CM5DYwpfu9kjcat11A7o68_7SRoab7ovTm9A
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 84,
"uid": "68d30a9594728bc39aa24be94b319d21",
"user": {
"id": 133,
"email": "marijaeezcjtyb@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/3a0eef66216ae1717af007f1af7b6100?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/3a0eef66216ae1717af007f1af7b6100?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/3a0eef66216ae1717af007f1af7b6100?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3a0eef66216ae1717af007f1af7b6100?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/3a0eef66216ae1717af007f1af7b6100?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:38+02:00"
},
"project": {
"id": 38,
"active": true,
"account_id": 61,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172199,
"external_id": null,
"budget_scope": null,
"client": {
"id": 39,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:38+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "start",
"timer_started_on": 1591172198,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172198,
"created_at": 1591172198,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:38+02:00",
"from": "2020-06-03T10:16:38+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 133,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Stop timer on an event
Request
curl "https://api.timelyapp.com/1.1/62/events/85/stop" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer A6x4_XLzXz-cSBHvS2yhgF_NLbOGBXxSgLwDWQI8eXw" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/stop
PUT /1.1/62/events/85/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer A6x4_XLzXz-cSBHvS2yhgF_NLbOGBXxSgLwDWQI8eXw
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 85,
"uid": "3ef815416f775098fe977004015c6193",
"user": {
"id": 135,
"email": "marijagbujizef@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/22a9116b1fbec238066e8e4cf238a7b0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/22a9116b1fbec238066e8e4cf238a7b0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/22a9116b1fbec238066e8e4cf238a7b0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/22a9116b1fbec238066e8e4cf238a7b0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/22a9116b1fbec238066e8e4cf238a7b0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:39+02:00"
},
"project": {
"id": 39,
"active": true,
"account_id": 62,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172199,
"external_id": null,
"budget_scope": null,
"client": {
"id": 40,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:39+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 4,
"minutes": 30,
"seconds": 0,
"formatted": "04:30",
"total_hours": 4.5,
"total_seconds": 16200,
"total_minutes": 270
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 22500,
"formatted": "$225.00",
"amount": 225.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "stop",
"timer_started_on": 0,
"timer_stopped_on": 1591172199,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172199,
"created_at": 1591172199,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:39+02:00",
"from": "2020-06-03T10:16:39+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 135,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Update an event
Note: Normal users can edit the project_id and events created by other users on their account. Limited users can only edit their own events.
Request
curl "https://api.timelyapp.com/1.1/63/events/86" -d '{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer r5EeJGoltkwzBvxCcFBB5gPHEQJf4TEjzUIu6o8p6AA" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id
PUT /1.1/63/events/86
Accept: application/json
Content-Type: application/json
Authorization: Bearer r5EeJGoltkwzBvxCcFBB5gPHEQJf4TEjzUIu6o8p6AA
Parameters
{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
| Name | Description |
|---|---|
| id required | Event ID |
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| project_id | Project ID |
| estimated_minutes | Specifies estimated minutes for an event. Example values: 0-60 |
| estimated_hours | Specifies estimated hours for an event. Example values: 0-12 |
| note | Specifies notes for an event |
| from | Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies label IDs for an event. Example values: label_ids:[2,3,4] |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 86,
"uid": "93db85ed909c13838ff95ccfa94cebd9",
"user": {
"id": 137,
"email": "marijaqwjnhxoy@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/86145025bf99462e225f8b0e80f11e80?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/86145025bf99462e225f8b0e80f11e80?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/86145025bf99462e225f8b0e80f11e80?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/86145025bf99462e225f8b0e80f11e80?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/86145025bf99462e225f8b0e80f11e80?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"updated_at": "2020-06-03T10:16:39+02:00"
},
"project": {
"id": 40,
"active": true,
"account_id": 63,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172199,
"external_id": null,
"budget_scope": null,
"client": {
"id": 41,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:39+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2020-06-03",
"note": "Updated notes",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1591172200,
"created_at": 1591172199,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2020-06-03T13:46:39+02:00",
"from": "2020-06-03T10:16:39+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 137,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Labels
Labels (AKA Tags) help you classify work, group related tasks and require certain information for events. This API lets you to create, list, update and delete tags created on an account.
Create a label
Request
curl "https://api.timelyapp.com/1.1/73/labels" -d '{"label":{"name":"Web Programming"}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ffqbPfnD1KSH_IpSLgN91XiHNqVEgyQmmJoe1lC_l7s" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/labels
POST /1.1/73/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer ffqbPfnD1KSH_IpSLgN91XiHNqVEgyQmmJoe1lC_l7s
Parameters
{"label":{"name":"Web Programming"}}
| Name | Description |
|---|---|
| name required | Specifies the label name |
| emoji | Specifies the emoji url for a label |
| parent_id | Set a parent_id if you want to create a child label |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 1,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v4.0.4/img-twitter-64/1f3f7-fe0f.png",
"children": [
]
}
Delete a label
Request
curl "https://api.timelyapp.com/1.1/74/labels/2" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer c4JHjCr9tvJ64dUi9Z5_sZq80yPOaA-_LnaFqlqANvE" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/labels/:id
DELETE /1.1/74/labels/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer c4JHjCr9tvJ64dUi9Z5_sZq80yPOaA-_LnaFqlqANvE
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the label you want to delete |
| id | The ID of the label you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all child labels
Get the children of any tag on a user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/77/labels?parent_id=4" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer l2AnIEUWZzoLHnFI9FcDcM05Q3GYeYWppNshQrWIUu4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/77/labels?parent_id=4
Accept: application/json
Content-Type: application/json
Authorization: Bearer l2AnIEUWZzoLHnFI9FcDcM05Q3GYeYWppNshQrWIUu4
Parameters
parent_id: 4
| Name | Description |
|---|---|
| account_id | The account ID containing the label you want to. retrieve |
| parent_id | The parent ID whose children you want to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 4,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"children": [
]
}
List all labels
Get all the tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/76/labels" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 47n2FGD3F_dhKWaeP1piLNFBkyacnBUJ6viMZP-IEjU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/76/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer 47n2FGD3F_dhKWaeP1piLNFBkyacnBUJ6viMZP-IEjU
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
]
Retrieve a label
Get single tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/75/labels/3" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6lSEd1bCUErk4Mqz25uWGA6YSaur4rrSf-sKab_4A9s" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels/:id
GET /1.1/75/labels/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6lSEd1bCUErk4Mqz25uWGA6YSaur4rrSf-sKab_4A9s
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the label you want to. retrieve |
| id | The ID of the label you want to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"children": [
]
}
Update a label
Request
curl "https://api.timelyapp.com/1.1/78/labels/5" -d '{"label":{"name":"updated name"}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ahae1d-0N-9rYDuXmqYKt0qD9FO1xeToy38robId0r8" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/labels/:id
PUT /1.1/78/labels/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ahae1d-0N-9rYDuXmqYKt0qD9FO1xeToy38robId0r8
Parameters
{"label":{"name":"updated name"}}
| Name | Description |
|---|---|
| id required | Label ID |
| name required | Specifies the label name |
| emoji | Specifies the emoji url for a tag |
| parent_id | Set a parent_id if you want to create a child label |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5,
"name": "updated name",
"sequence": 1,
"parent_id": null,
"emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v4.0.4/img-twitter-64/1f3f7-fe0f.png",
"children": [
]
}
Permissions
Retrieve current user's permissions
Using the account id one can see the currently logged user's permissions
Request
curl -g "https://api.timelyapp.com/1.1/89/users/current/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 0GNV_5auKWT48jAeCYJOLDv33KbWRfjUekln7RtT1eE" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current/permissions
GET /1.1/89/users/current/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0GNV_5auKWT48jAeCYJOLDv33KbWRfjUekln7RtT1eE
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which current user's permissions are to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"resource": "user",
"permissions": [
"create",
"read",
"update",
"delete",
"notify"
]
},
{
"resource": "project",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "label",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "company",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "team",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "account",
"permissions": [
"create",
"read",
"update",
"manage_plan",
"manage_subscriptions",
"manage_dev"
]
},
{
"resource": "report",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "forecast",
"permissions": [
"create",
"read",
"update",
"delete"
]
}
]
Retrieve user's permissions by id
Using the account id and user id one can see a specific user's permissions
Request
curl -g "https://api.timelyapp.com/1.1/90/users/188/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 8Lj50En-7_9H19amnuqP_nENnC63n2IvJNdfhbeZNJY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/permissions
GET /1.1/90/users/188/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8Lj50En-7_9H19amnuqP_nENnC63n2IvJNdfhbeZNJY
Parameters
| Name | Description |
|---|---|
| account_id | Account for which user's permissions are required |
| user_id | User whose permissions are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"resource": "user",
"permissions": [
"create",
"read",
"update",
"delete",
"notify"
]
},
{
"resource": "project",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "label",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "company",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "team",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "account",
"permissions": [
"create",
"read",
"update",
"manage_plan",
"manage_subscriptions",
"manage_dev"
]
},
{
"resource": "report",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "forecast",
"permissions": [
"create",
"read",
"update",
"delete"
]
}
]
Projects
Projects contain all the project details on an account. With this API, you can retrieve, update, create or delete a specific project, or list all projects.
Create a project
Request
curl "https://api.timelyapp.com/1.1/96/projects" -d '{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":65,"budget_type":"M","budget":300,"users":[{"user_id":200}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":6,"required":true},{"label_id":7,"required":true},{"label_id":8,"required":false},{"label_id":9,"required":false}]}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer fQIQ7T2cQmwWHgOx1EqOFK5d61_oHzXO40x0GZ0FjKo" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects
POST /1.1/96/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer fQIQ7T2cQmwWHgOx1EqOFK5d61_oHzXO40x0GZ0FjKo
Parameters
{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":65,"budget_type":"M","budget":300,"users":[{"user_id":200}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":6,"required":true},{"label_id":7,"required":true},{"label_id":8,"required":false},{"label_id":9,"required":false}]}}
| Name | Description |
|---|---|
| project required | Project attributes |
| name required | Specifies the project name |
| color required | Specifies the project color. It should be one of these: 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0 |
| client_id required | Specifies the numerical client ID |
| users required | Specifies the project users. It should be an array of users, with numerical user IDs and an hour_rate. For example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }] |
| billable | Specifies whether the project is billable or not. It should be “true” or “false” |
| budget | Specifies the budget for the project. It should be numeric value |
| hour_rate | Specifies the hourly rate for the project. It should be numeric valu |
| rate_type | Specifies the hourly rate type for the project. It should be “user” or “project” |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
| budget_recurrence | Specifies when a recurring budget will refresh |
| send_invite | Specifies if you want to send a project invite email. It should be “true” or “false” |
| required_notes | Project hours notes to be required for logging |
| labels | Specifies the project labels, should be array of labels with numerical label id and required flag Example: "labels": [{ "label_id": 1, "required": true }, { "label_id": 2, "required": false }] |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 65,
"active": true,
"account_id": 96,
"name": "New Project",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172211,
"external_id": null,
"budget_scope": null,
"client": {
"id": 65,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:51+02:00"
},
"required_notes": false,
"budget": 300,
"budget_type": "M",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"users": [
{
"user_id": 200,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2020-06-03T10:16:51+02:00",
"created_at": "2020-06-03T10:16:51+02:00",
"deleted": false
}
],
"labels": [
{
"project_id": 65,
"label_id": 6,
"budget": null,
"required": true,
"updated_at": "2020-06-03T10:16:51+02:00"
},
{
"project_id": 65,
"label_id": 7,
"budget": null,
"required": true,
"updated_at": "2020-06-03T10:16:51+02:00"
},
{
"project_id": 65,
"label_id": 8,
"budget": null,
"required": false,
"updated_at": "2020-06-03T10:16:51+02:00"
},
{
"project_id": 65,
"label_id": 9,
"budget": null,
"required": false,
"updated_at": "2020-06-03T10:16:51+02:00"
}
],
"label_ids": [
6,
7,
8,
9
],
"required_label_ids": [
6,
7
],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"first_logged_on": null,
"last_logged_on": null,
"budget_recurrence": {
"recur": "week",
"start_date": "2018-09-21",
"end_date": "2019-09-21",
"recur_until": "end_date",
"days_count": 365,
"updated_at": "2020-06-03T10:16:51+02:00"
}
}
Delete a project
Request
curl "https://api.timelyapp.com/1.1/97/projects/66" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ExioVtU1iU14KpwYRbtqj4_KMZL_GoPkOfl-h0IjonY" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/projects/:id
DELETE /1.1/97/projects/66
Accept: application/json
Content-Type: application/json
Authorization: Bearer ExioVtU1iU14KpwYRbtqj4_KMZL_GoPkOfl-h0IjonY
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the project you want to delete |
| id | The ID of the project you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all projects
Note: Admin users can access all projects on an account. Other users can only access the projects they belong to.
Project lists will return your 10000 most recently updated projects. Additionally, you can add the “limit”, “filter”, ”sort” and “order” optional parameters to change the result.
Request
curl -g "https://api.timelyapp.com/1.1/99/projects" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6l2T8M34ZhOLQcYXfAKUVLZOf1AZvalHRbZOvPomw0M" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects
GET /1.1/99/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6l2T8M34ZhOLQcYXfAKUVLZOf1AZvalHRbZOvPomw0M
Parameters
| Name | Description |
|---|---|
| offset | Retrieve projects from offset |
| limit | Retrieve number of projects |
| sort | Field to sort projects by (Default updated_at) |
| order | Sorting order (Default desc) |
| filter | Filter projects - mine, active, archived, all |
| updated_after | Retrieve records updated after a certain timestamp |
| project_ids | Retrieve specific projects |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 68,
"active": true,
"account_id": 99,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172212,
"external_id": null,
"budget_scope": null,
"client": {
"id": 68,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:52+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"users": [
{
"user_id": 206,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2020-06-03T10:16:52+02:00",
"created_at": "2020-06-03T10:16:52+02:00",
"deleted": false
}
],
"labels": [
],
"label_ids": [
],
"required_label_ids": [
],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
}
}
]
Retrieve a project
Retrieve a single project by using its ID.
Request
curl -g "https://api.timelyapp.com/1.1/98/projects/67" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 2sAqtQtMlJ4B7srquCuDD47ldwynh16OauIh_HYrux8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:id
GET /1.1/98/projects/67
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2sAqtQtMlJ4B7srquCuDD47ldwynh16OauIh_HYrux8
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the project you want to retrieve |
| id | The ID of the project you want to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 67,
"active": true,
"account_id": 98,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172212,
"external_id": null,
"budget_scope": null,
"client": {
"id": 67,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:52+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"users": [
{
"user_id": 204,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2020-06-03T10:16:52+02:00",
"created_at": "2020-06-03T10:16:52+02:00",
"deleted": false
}
],
"labels": [
],
"label_ids": [
],
"required_label_ids": [
],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"first_logged_on": null,
"last_logged_on": null
}
Update a project
Request
curl "https://api.timelyapp.com/1.1/101/projects/70" -d '{"project":{"name":"updated project name"}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Q44DJ-4Uz1G6vJajRMUDQgoU3ppixHs7NVZ5fO8C8E0" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:id
PUT /1.1/101/projects/70
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q44DJ-4Uz1G6vJajRMUDQgoU3ppixHs7NVZ5fO8C8E0
Parameters
{"project":{"name":"updated project name"}}
| Name | Description |
|---|---|
| id required | Project ID |
| project | Project attributes |
| name required | Specifies the project name |
| active | Example values: “true” or “false”. Using “false” changes the project state to “archived” |
| color required | Specifies the project color. It should be one of these: 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0 |
| client_id required | Specifies the numerical client ID |
| users required | Specifies the project users. It should be an array of users, with numerical user IDs and an hour_rate. For example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }] |
| billable | Specifies whether the project is billable or not. It should be “true” or “false” |
| budget | Specifies the budget for the project. It should be numeric value |
| hour_rate | Specifies the hourly rate for the project. It should be numeric value |
| rate_type | Specifies the hourly rate type for the project. It should be “user” or “project” |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
| send_invite | Specifies if you want to send a project invite email. It should be “true” or “false” |
| required_notes | Project hours notes to be required for logging |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 70,
"active": true,
"account_id": 101,
"name": "updated project name",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172213,
"external_id": null,
"budget_scope": null,
"client": {
"id": 70,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:16:53+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"users": [
{
"user_id": 210,
"hour_rate": 0.0,
"hour_rate_in_cents": 0.0,
"updated_at": "2020-06-03T10:16:53+02:00",
"created_at": "2020-06-03T10:16:53+02:00",
"deleted": false
}
],
"labels": [
],
"label_ids": [
],
"required_label_ids": [
],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"first_logged_on": null,
"last_logged_on": null
}
Reports
Enjoy clear oversight over your business, including individual and team performance. Export reports in .XLS, .PDF and .CSV formats.
All Reports
For a normal user accessing all account reports.
Note:
1) If start_date and end_date parameters are not passed, the period will default to the beginning-to-end of a month. 2) If user and project parameters are not passed, by default a normal user will get all reports on an account, and a limited user will only get reports they have created. 3) Only normal users can access reports created by other users on an account. Limited users can only access reports they have created. 4) Only normal users can access reports for other projects on an account. Limited users can only access reports for projects they have created.
Request
curl "https://api.timelyapp.com/1.1/133/reports" -d '{"user_ids":"305","since":"2018-01-01","until":"2019-01-01","project_ids":"139"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer kET_h6AkyMmI8_1B1evz8lqw34ylSROoskeExXEyMlc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports
POST /1.1/133/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer kET_h6AkyMmI8_1B1evz8lqw34ylSROoskeExXEyMlc
Parameters
{"user_ids":"305","since":"2018-01-01","until":"2019-01-01","project_ids":"139"}
| Name | Description |
|---|---|
| account_id | The account ID containing the report you want to retrieve |
| user_ids | Specifies the users for which you want reports. Numerical user IDs should separated by a comma, like so: "user_ids": "175551,117861" |
| since | Specifies the start date for a report: For example: "since" : "Jan 01, 2014" |
| until | Specifies the end date for a report. For example: "until" : "Dec 31, 2014" |
| project_ids | Specifies the projects for which you want reports. Numerical project IDs should be separated by a comma, like so: "project_ids": "1751,1171" |
| billed | Specifies whether you want to report to show estimated or billed events. For example: "billed": false or "billed": true |
| label_ids | Specifies the labels pertaining to a report you want to see. Numerical label IDs should be separated by a comma, like so: "label_ids": "751,117" |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 102,
"name": "Timely",
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"projects": [
{
"id": 139,
"active": true,
"account_id": 133,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172229,
"external_id": null,
"budget_scope": null,
"client": {
"id": 102,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:17:09+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
}
}
]
}
]
Filter reports
Use filter endpoints with parameters to limit returned data, so you only see the values that you need.
Request
curl "https://api.timelyapp.com1.1/134/reports/filter" -d '{"user_ids":"307","since":"2018-01-01","until":"2019-01-01","project_ids":"140"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer QRzOXT8XZ2NZ2m3q6HieNJnlPRpVAQ8WbnwCXi76zG4" \
-H "Cookie: "
Endpoint
POST 1.1/:account_id/reports/filter
POST 1.1/134/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer QRzOXT8XZ2NZ2m3q6HieNJnlPRpVAQ8WbnwCXi76zG4
Parameters
{"user_ids":"307","since":"2018-01-01","until":"2019-01-01","project_ids":"140"}
| Name | Description |
|---|---|
| billed | Retrieve billed hours only. Example: billed=true |
| label_ids | Specifies the label IDs of the hours you want to retrieve. Label IDs should be a numerical array, like so: label_ids: [3, 4, 2] |
| project_ids | Specifies the project IDs of the hours you want to retrieve. Project IDs should be a numerical array, like so: project_ids: [3, 4, 2] |
| since | The start date of a report. For example: 'since=2019-01-01' |
| team_ids | Specifies the team IDs of the hours you want to retrieve. Team IDs should be a numerical array, like so: team_ids: [3, 4, 2] |
| until | The end date of a report. For example: 'until=2019-12-31'' |
| user_ids | Specifies the user IDs of the hours you want to retrieve. User IDs should be a numerical array, like so: user_ids: [3, 4, 2] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"clients": [
{
"id": 103,
"name": "Timely",
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"projects": [
{
"id": 140,
"active": true,
"account_id": 134,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1591172229,
"external_id": null,
"budget_scope": null,
"client": {
"id": 103,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2020-06-03T10:17:09+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_percent": 0.0,
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
}
}
]
}
],
"users": [
{
"id": 307,
"email": "marijazrkdpaia@timelyapp.com",
"name": "Marija Petrovic",
"time_zone": "Europe/Paris",
"updated_at": 1591172229,
"active": false,
"deleted": false,
"memory_onboarded": true,
"day_view_onboarded": true,
"last_received_memories_date": null,
"date_format": "dmy",
"time_format": "24",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/dc99167ce911405986d25e7fc13504ef?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/dc99167ce911405986d25e7fc13504ef?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/dc99167ce911405986d25e7fc13504ef?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/dc99167ce911405986d25e7fc13504ef?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/dc99167ce911405986d25e7fc13504ef?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
},
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
}
}
],
"labels": [
{
"id": 0,
"name": "Untagged",
"sequence": -1,
"parent_id": null,
"emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v2.4.4/img-twitter-64/1f3f7.png",
"children": [
],
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
}
}
],
"days": [
{
"day": "2018-01-02",
"duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
}
},
{
"day": "2018-01-01",
"duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
}
}
]
}
Roles
List roles
Note: default attribute shows which role to select by default
Request
curl -g "https://api.timelyapp.com/1.1/135/roles" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 38cdjh9OYE6I4Pk_HaQO-mU4dceHaMA8Ib5BanqNHQY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/roles
GET /1.1/135/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer 38cdjh9OYE6I4Pk_HaQO-mU4dceHaMA8Ib5BanqNHQY
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which roles are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 403,
"name": "admin",
"display_name": "Admin",
"description": "Can see, create and edit all hours, projects and teams.",
"scopes": [
{
"name": "hide_hourly_rate",
"display_name": "Hide rate",
"description": "Hide hourly rates for this user",
"default": false,
"options": [
false
]
}
],
"default": false
},
{
"id": 405,
"name": "employee",
"display_name": "Employee",
"description": "Can only see, log and edit their own hours.",
"scopes": [
{
"name": "hide_hourly_rate",
"display_name": "Hide rate",
"description": "Hide hourly rates for this user",
"default": false,
"options": [
true,
false
]
}
],
"default": false
},
{
"id": 404,
"name": "manager",
"display_name": "Manager",
"description": "Can see, log and edit hours for anyone on the same project as them.",
"scopes": [
{
"name": "hide_hourly_rate",
"display_name": "Hide rate",
"description": "Hide hourly rates for this user",
"default": false,
"options": [
true,
false
]
}
],
"default": true
}
]
Teams
The team object shows all teams available on an account.
Create a team
Request
curl "https://api.timelyapp.com/1.1/153/teams" -d '{"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":345,"lead":true},{"user_id":347,"lead":false}]}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ns1zqwxK6jNiLffZ8eMLOBjFjyxkcXgaQoch2_J9iMM" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/teams
POST /1.1/153/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer ns1zqwxK6jNiLffZ8eMLOBjFjyxkcXgaQoch2_J9iMM
Parameters
{"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":345,"lead":true},{"user_id":347,"lead":false}]}}
| Name | Description |
|---|---|
| name required | Specifies the team name |
| emoji | Specifies the emoji url for a team |
| color | Specifies the project color for a team |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
| users required | Specifies users and their role within a team. For example: users:[{'user_id': 1, 'lead': true}] |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 1,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
345,
347
],
"users": [
{
"id": 1,
"user_id": 345,
"team_id": 1,
"lead": true
},
{
"id": 2,
"user_id": 347,
"team_id": 1,
"lead": false
}
]
}
Delete a team
Request
curl "https://api.timelyapp.com/1.1/154/teams/2" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer tOL5QXvdDa5XBSOKH6a0m05WnkXxFiPzZ-6bWnv7fJw" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/teams/:id
DELETE /1.1/154/teams/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer tOL5QXvdDa5XBSOKH6a0m05WnkXxFiPzZ-6bWnv7fJw
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the team you want to delete |
| id | The ID of the team you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all teams
Request
curl -g "https://api.timelyapp.com/1.1/156/teams" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6osuOMVwI3E9cvBd9mFRvSPWRJfSvZ_NiTzhU8--52c" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams
GET /1.1/156/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6osuOMVwI3E9cvBd9mFRvSPWRJfSvZ_NiTzhU8--52c
Parameters
| Name | Description |
|---|---|
| page | Page number (Default 1) |
| per_page | Records per page (Default 50) |
| order | Sorting order on name |
| filter | Filter teams - mine, all |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 4,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
],
"users": [
]
}
]
Retrieve a team
Request
curl -g "https://api.timelyapp.com/1.1/155/teams/3" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer p2yJvN1tB-9S3nRIFVeRnhtQtSaNPcuM_jWTMD4iU5I" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams/:id
GET /1.1/155/teams/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer p2yJvN1tB-9S3nRIFVeRnhtQtSaNPcuM_jWTMD4iU5I
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the team you want to retrieve |
| id | The ID of the team you want to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
],
"users": [
]
}
Update a team
Request
curl "https://api.timelyapp.com/1.1/157/teams/5" -d '{"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":354,"lead":true}]}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer V3d0X_Bc-UuKcHpJxYfyumgC1U_7I43gpkpmSS6keAQ" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/teams/:id
PUT /1.1/157/teams/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer V3d0X_Bc-UuKcHpJxYfyumgC1U_7I43gpkpmSS6keAQ
Parameters
{"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":354,"lead":true}]}}
| Name | Description |
|---|---|
| name required | Specifies the team name |
| emoji | Specifies the emoji url for a team |
| color | Specifies the project color for a team |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
| users required | Specific users with their role in the team. Ex: users:[{'user_id': 1, 'lead': true}] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5,
"name": "Backend",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
354
],
"users": [
{
"id": 3,
"user_id": 354,
"team_id": 5,
"lead": true
}
]
}
Users
An account can have multiple users associated with it. All users have a specific access level, and are usually created by an employer on behalf of an employee.
Create/Invite a user
Note: user_level can have values “normal” or “limited”. A user’s name and email can only be updated by the user themself.
Request
curl "https://api.timelyapp.com/1.1/162/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":169,"hour_rate":10}]},"admin":{"id":160,"email":"notifications@timelyapp.com","created_at":"2020-06-03T10:17:22.000+02:00","updated_at":"2020-06-03T10:17:22.000+02:00","name":"Timely","notifier":false}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer qp_ZObFNGkrxzOhLM-Pd9c5hY1A3GtZFHVs36NFS2Dg" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users
POST /1.1/162/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer qp_ZObFNGkrxzOhLM-Pd9c5hY1A3GtZFHVs36NFS2Dg
Parameters
{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":169,"hour_rate":10}]},"admin":{"id":160,"email":"notifications@timelyapp.com","created_at":"2020-06-03T10:17:22.000+02:00","updated_at":"2020-06-03T10:17:22.000+02:00","name":"Timely","notifier":false}}
| Name | Description |
|---|---|
| user required | Label attributes |
| name required | Specifies the user name |
| email required | Specifies the user email |
| projects | Description: Specifies the projects that the user will be part of. For example: "projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }] |
| role_id required | Specifies the user's role in the account |
| user_level | (Deprecated) Specifies the user level; either “normal” or “limited”. The default is "normal". For example: "user_level": "normal" |
| admin | (Deprecated) Specifies the user is an admin. In this case user_level should be “normal”. For example: "admin": "true" |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 366,
"email": "marija@timely.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": false,
"memory_onboarded": false,
"created_at": 1591172242,
"updated_at": 1591172242,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Etc/UTC",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
"small": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
},
"type": "User",
"user_level": "manager",
"admin": false,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 485,
"role": {
"id": 485,
"name": "manager"
}
}
Delete a user
Request
curl "https://api.timelyapp.com/1.1/163/users/367" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 74FHZvuIKCYTzOMdKzWhXBkC5Q7Z4JMDPMptcOGrwz4" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/users/:id
DELETE /1.1/163/users/367
Accept: application/json
Content-Type: application/json
Authorization: Bearer 74FHZvuIKCYTzOMdKzWhXBkC5Q7Z4JMDPMptcOGrwz4
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the user you want to delete |
| id | The ID of the user you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all users
Note: The user list will return the 10 most recently updated users.
Request
curl -g "https://api.timelyapp.com/1.1/166/users" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer b1NDiVeqh1RsGFNOl4LejijtL76C4BMUOW4uMB5ym6U" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users
GET /1.1/166/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer b1NDiVeqh1RsGFNOl4LejijtL76C4BMUOW4uMB5ym6U
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the users you want to retrieve |
| limit | Retrieve a limited number of users |
| offset | Retrieve users from offset |
| order | Sorting order on updated_at |
| filter | Filter users - Ex: filter=deleted |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 373,
"email": "marijamuqvzsav@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1591172244,
"updated_at": 1591172244,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8c4600d911591d5f90c9cf50729e8cb8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8c4600d911591d5f90c9cf50729e8cb8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/8c4600d911591d5f90c9cf50729e8cb8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8c4600d911591d5f90c9cf50729e8cb8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/8c4600d911591d5f90c9cf50729e8cb8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
"small": "https://www.gravatar.com/avatar/8c4600d911591d5f90c9cf50729e8cb8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
},
"type": "User",
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 496,
"role": {
"id": 496,
"name": "admin"
}
}
]
Retrieve a user
Request
curl -g "https://api.timelyapp.com/1.1/164/users/369" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer F7Ie9lqjjKXakMDvFPPaoa1oVYK81B78-HuX-iOpPiA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:id
GET /1.1/164/users/369
Accept: application/json
Content-Type: application/json
Authorization: Bearer F7Ie9lqjjKXakMDvFPPaoa1oVYK81B78-HuX-iOpPiA
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the users you want to retrieve |
| id | The ID of the user you want to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 369,
"email": "marijasunlzqet@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1591172243,
"updated_at": 1591172243,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/609b45a2d8b7f83d3e6f846387fa1efc?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/609b45a2d8b7f83d3e6f846387fa1efc?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/609b45a2d8b7f83d3e6f846387fa1efc?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/609b45a2d8b7f83d3e6f846387fa1efc?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/609b45a2d8b7f83d3e6f846387fa1efc?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
"small": "https://www.gravatar.com/avatar/609b45a2d8b7f83d3e6f846387fa1efc?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
},
"type": "User",
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 490,
"role": {
"id": 490,
"name": "admin"
}
}
Retrieve current user
Request
curl -g "https://api.timelyapp.com/1.1/165/users/current" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 32gtkbaaB6loEMKeUvXMfBiumpIqSmu4VcrMOiIDBbM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current
GET /1.1/165/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer 32gtkbaaB6loEMKeUvXMfBiumpIqSmu4VcrMOiIDBbM
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the current user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 371,
"email": "marijahthhtsoq@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1591172243,
"updated_at": 1591172243,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/184e083db3f2485362ccbf2193b963a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/184e083db3f2485362ccbf2193b963a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/184e083db3f2485362ccbf2193b963a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/184e083db3f2485362ccbf2193b963a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/184e083db3f2485362ccbf2193b963a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
"small": "https://www.gravatar.com/avatar/184e083db3f2485362ccbf2193b963a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
},
"type": "User",
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 493,
"role": {
"id": 493,
"name": "admin"
}
}
Update a user
Note:
Please use the parameters mentioned in “Create/Invite a user”.
Only admins can edit “user_level” and “projects” fields for other users.
Admins can update other users’ profiles. Limited users can only update their own profile.
Request
curl "https://api.timelyapp.com/1.1/167/users/375" -d '{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":174,"hour_rate":10}]},"admin":{"id":165,"email":"notifications@timelyapp.com","created_at":"2020-06-03T10:17:24.000+02:00","updated_at":"2020-06-03T10:17:24.000+02:00","name":"Timely","notifier":false}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer V4-Pe7TvKkKb979yAESuGmwwrs7I2bHmNnDVm38CU6A" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:id
PUT /1.1/167/users/375
Accept: application/json
Content-Type: application/json
Authorization: Bearer V4-Pe7TvKkKb979yAESuGmwwrs7I2bHmNnDVm38CU6A
Parameters
{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":174,"hour_rate":10}]},"admin":{"id":165,"email":"notifications@timelyapp.com","created_at":"2020-06-03T10:17:24.000+02:00","updated_at":"2020-06-03T10:17:24.000+02:00","name":"Timely","notifier":false}}
| Name | Description |
|---|---|
| id required | the numerical ID of the user |
| user required | Label attributes |
| name required | Specifies the user name |
| email required | Specifies the user email |
| projects | Specifies the projects that the user will be part of. For example: "projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }] |
| role_id required | Specifies the user's role in the account |
| user_level | (Deprecated) Specifies the user level; either “normal” or “limited”. The default is "normal". For example: "user_level": "normal" |
| admin | (Deprecated) Specifies the user is an admin. In this case user_level should be “normal”. For example: "admin": "true" |
| external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 375,
"email": "marijapirvvqqe@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1591172244,
"updated_at": 1591172244,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/0419f6e1a7f8749ab797d2fd812015ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0419f6e1a7f8749ab797d2fd812015ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/0419f6e1a7f8749ab797d2fd812015ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0419f6e1a7f8749ab797d2fd812015ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/0419f6e1a7f8749ab797d2fd812015ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
"small": "https://www.gravatar.com/avatar/0419f6e1a7f8749ab797d2fd812015ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
},
"type": "User",
"user_level": "manager",
"admin": false,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 500,
"role": {
"id": 500,
"name": "manager"
}
}
Errors
Example responses:
422 Unprocessable Entity
{
"errors":{
"name":[
"can't be blank"
],
"project_users":[
"is invalid"
]
}
}
422 Unprocessable Entity
403 Forbidden
{
"errors":{
"message":"error message"
}
}
404 Not Found
{
"errors":{
"message":"Not Found"
}
}
401 Unauthorized
{
"errors":{
"message":"Unauthorized"
}
}
Timely uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed due to the information provided. Codes in the 5xx range indicate an error with Timely's servers.
Unauthorized access o projects and accounts, or trying to create or delete objects that are not under our control, will result in errors.
The Timely API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 - Bad Request | Your request is invalid |
| 401 - Unauthorized | Wrong authentication token was used |
| 403 - Forbidden | The entity requested is hidden from unauthorized access |
| 404 - Not Found | The specified entity could not be found |
| 422 - Unprocessable Entity | The server understands the content type, but was unable to process the request |
| 500 - Internal Server Error | We’re experiencing a problem with our server. Try again later. |