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 Daj25eVrSwbAHKh4mFn4EhFxa839W06yjtoXKshLllk" \
-H "Cookie: "
Endpoint
GET /1.1/accounts
GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer Daj25eVrSwbAHKh4mFn4EhFxa839W06yjtoXKshLllk
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 18,
"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-8bc212c450af14b3a0ea49098cdddbe4f90d5eb5fc57adfeade6ac1ad8fb1d4a.png",
"medium_retina": "/assets/account_thumbs/account_medium_retina-10dfbcc6733ccba1d485971f63c5eb7f9b7ed1a942a0ebd140e292bcb1e4dbea.png",
"small_retina": "/assets/account_thumbs/account_small_retina-ea5df153b4cd96fc801e2361afc7d1b06d7b95ce5c358250b81149e1a20689df.png",
"brand_logo": false
},
"from": "Web",
"max_users": 0,
"seats": 1,
"max_projects": 0,
"plan_id": 18,
"plan_name": "Essential",
"next_charge": "2021-05-29",
"start_of_week": 0,
"created_at": 1619711332,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 40,
"weekly_user_capacity": 40.0,
"default_hour_rate": 0.0,
"support_email": "support@timelyapp.com",
"estimated_company_size": null,
"industry": null,
"num_users": 1,
"num_projects": 0,
"active_projects_count": 0,
"total_projects_count": 0,
"capacity": {
"hours": 40,
"minutes": 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
},
{
"name": "premium_integrations",
"days": -1
},
{
"name": "individual_capacity",
"days": -1
},
{
"name": "audits",
"days": -1
},
{
"name": "project_dashboard",
"days": -1
},
{
"name": "high_level_reports",
"days": -1
},
{
"name": "live_reports",
"days": -1
},
{
"name": "invoices",
"days": -1
},
{
"name": "tasks",
"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/16/activities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ntLEVCHVoG3iEy1J7Y8bm-E6nd-MxULkA-WraEB3Hrs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/activities
GET /1.1/16/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer ntLEVCHVoG3iEy1J7Y8bm-E6nd-MxULkA-WraEB3Hrs
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": 35,
"email": "marijagttlurcy@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:48:51+02:00"
},
"message": "archived",
"activity_type": "archive_project",
"url": "http://app.timelyapp.local:3002/16/projects/11",
"updated_at": "2021-04-22T17:48:51+02:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 11,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 11,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:48:51+02:00"
},
"updated_at": "2021-04-29T17:48:51+02:00"
},
"anomaly": false
},
{
"id": 18,
"user": {
"id": 35,
"email": "marijagttlurcy@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/8e13ad051210f2ba66f1df22bde53253?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:48:51+02:00"
},
"message": "50% of budget used",
"activity_type": "project_budget_progress_fifty",
"url": "http://app.timelyapp.local:3002/16/projects/11",
"updated_at": "2021-04-29T17:48:51+02:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 11,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 11,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:48:51+02:00"
},
"updated_at": "2021-04-29T17:48:51+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/17" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 12nsOqJbAjjmWGR5OVQ8zje5ALiENdqpjuSqMgflJxA" \
-H "Cookie: "
Endpoint
GET /1.1/accounts/:id
GET /1.1/accounts/17
Accept: application/json
Content-Type: application/json
Authorization: Bearer 12nsOqJbAjjmWGR5OVQ8zje5ALiENdqpjuSqMgflJxA
Parameters
| Name | Description |
|---|---|
| id | The id of the account to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 17,
"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-8bc212c450af14b3a0ea49098cdddbe4f90d5eb5fc57adfeade6ac1ad8fb1d4a.png",
"medium_retina": "/assets/account_thumbs/account_medium_retina-10dfbcc6733ccba1d485971f63c5eb7f9b7ed1a942a0ebd140e292bcb1e4dbea.png",
"small_retina": "/assets/account_thumbs/account_small_retina-ea5df153b4cd96fc801e2361afc7d1b06d7b95ce5c358250b81149e1a20689df.png",
"brand_logo": false
},
"from": "Web",
"max_users": 0,
"seats": 1,
"max_projects": 0,
"plan_id": 17,
"plan_name": "Essential",
"next_charge": "2021-05-29",
"start_of_week": 0,
"created_at": 1619711332,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 38,
"weekly_user_capacity": 40.0,
"default_hour_rate": 0.0,
"support_email": "support@timelyapp.com",
"estimated_company_size": null,
"industry": null,
"num_users": 1,
"num_projects": 0,
"active_projects_count": 0,
"total_projects_count": 0,
"capacity": {
"hours": 40,
"minutes": 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
},
{
"name": "premium_integrations",
"days": -1
},
{
"name": "individual_capacity",
"days": -1
},
{
"name": "audits",
"days": -1
},
{
"name": "project_dashboard",
"days": -1
},
{
"name": "high_level_reports",
"days": -1
},
{
"name": "live_reports",
"days": -1
},
{
"name": "invoices",
"days": -1
},
{
"name": "tasks",
"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/40/clients" -d '{"name":null,"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 AbbPiKyMc0uhyC2ugsagdmiAgP-trMCICsu-mz5lt0M" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/clients
POST /1.1/40/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer AbbPiKyMc0uhyC2ugsagdmiAgP-trMCICsu-mz5lt0M
Parameters
{"name":null,"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": 27,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:03+02:00"
}
List all clients
NOTE: Client list will return recently updated 10000 clients. Additionally, you can add the “limit”, “offset”, “filter” and “order” optional parameters to change the result.
Request
curl -g "https://api.timelyapp.com/1.1/41/clients" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer mPR3Jeskk_-ksGUb3hdwTfYxuVhqAJnf534NvBcoOQk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients
GET /1.1/41/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer mPR3Jeskk_-ksGUb3hdwTfYxuVhqAJnf534NvBcoOQk
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": 28,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:04+02:00",
"external_references": []
}
]
Show client
Request
curl -g "https://api.timelyapp.com/1.1/43/clients/30" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer FvQpOFzEI3gSH7cteXIhzpCC9xiPOrdRgN6oZmwiahk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients/:id
GET /1.1/43/clients/30
Accept: application/json
Content-Type: application/json
Authorization: Bearer FvQpOFzEI3gSH7cteXIhzpCC9xiPOrdRgN6oZmwiahk
Parameters
| Name | Description |
|---|---|
| account_id | Account ID for the client you want to retrieve |
| id | Client ID to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 30,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:05+02:00",
"external_references": []
}
Update a client
Update client details just by using a client’s ID.
Request
curl "https://api.timelyapp.com/1.1/45/clients/32" -d '{"name":null,"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 YGwhhPPZKWHVrcejt5Z7Ddg_-UvNpGA5UEpIFEvlSDU" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/clients/:id
PUT /1.1/45/clients/32
Accept: application/json
Content-Type: application/json
Authorization: Bearer YGwhhPPZKWHVrcejt5Z7Ddg_-UvNpGA5UEpIFEvlSDU
Parameters
{"name":null,"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": 32,
"name": "Updated name",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:06+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/64/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:13.822+02:00","to":"2021-04-29T21:19:13.822+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":38}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer cftVCAIu_CYLjfKxRIl777B0PII_Wz2Jzz5Ww2ZUXB8" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/events
POST /1.1/64/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer cftVCAIu_CYLjfKxRIl777B0PII_Wz2Jzz5Ww2ZUXB8
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:13.822+02:00","to":"2021-04-29T21:19:13.822+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":38}}
| 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": 81,
"uid": "43ec517d68b6edd3015b3edc9a11367b",
"user": {
"id": 137,
"email": "marijactdmhrqi@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/4aba3c6dcb76a4f282c74e50216c22b7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/4aba3c6dcb76a4f282c74e50216c22b7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/4aba3c6dcb76a4f282c74e50216c22b7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/4aba3c6dcb76a4f282c74e50216c22b7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/4aba3c6dcb76a4f282c74e50216c22b7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:13+02:00"
},
"project": {
"id": 38,
"active": true,
"account_id": 64,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711353,
"external_id": null,
"budget_scope": null,
"client": {
"id": 39,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:13+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"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": 1619711353,
"created_at": 1619711353,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:13+02:00",
"from": "2021-04-29T17:49:13+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 137,
"updater_id": 137,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
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/63/projects/37/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:13.228+02:00","to":"2021-04-29T21:19:13.228+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":37}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer iA2KWrZloObHyny5qaRT8mpy_VtlCxMecmg5JHvS-w4" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects/:project_id/events
POST /1.1/63/projects/37/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer iA2KWrZloObHyny5qaRT8mpy_VtlCxMecmg5JHvS-w4
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:13.228+02:00","to":"2021-04-29T21:19:13.228+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":37}}
| 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": 80,
"uid": "f033ab37c30201f73f142449d037028d",
"user": {
"id": 135,
"email": "marijahntwrcye@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/549d0017a743bf60bc86aab9384573a8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/549d0017a743bf60bc86aab9384573a8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/549d0017a743bf60bc86aab9384573a8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/549d0017a743bf60bc86aab9384573a8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/549d0017a743bf60bc86aab9384573a8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:12+02:00"
},
"project": {
"id": 37,
"active": true,
"account_id": 63,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711353,
"external_id": null,
"budget_scope": null,
"client": {
"id": 38,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:13+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"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": 1619711353,
"created_at": 1619711353,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:13+02:00",
"from": "2021-04-29T17:49:13+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 135,
"updater_id": 135,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
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/62/users/133/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:12.633+02:00","to":"2021-04-29T21:19:12.633+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":133}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer lShE7WpxbqKtWJu0QJr0jCFKRIWOccrDbr2aR24o9E8" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users/:user_id/events
POST /1.1/62/users/133/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer lShE7WpxbqKtWJu0QJr0jCFKRIWOccrDbr2aR24o9E8
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:12.633+02:00","to":"2021-04-29T21:19:12.633+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":133}}
| 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": 79,
"uid": "d1fe173d08e959397adf34b1d77e88d7",
"user": {
"id": 133,
"email": "marijaygxiczfc@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/833f74ec702c90256f21ba7c8310323b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/833f74ec702c90256f21ba7c8310323b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/833f74ec702c90256f21ba7c8310323b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/833f74ec702c90256f21ba7c8310323b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/833f74ec702c90256f21ba7c8310323b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:12+02:00"
},
"project": {
"id": 36,
"active": true,
"account_id": 62,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711352,
"external_id": null,
"budget_scope": null,
"client": {
"id": 37,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:12+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"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": 1619711352,
"created_at": 1619711352,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:12+02:00",
"from": "2021-04-29T17:49:12+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 133,
"updater_id": 133,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Create bulk events
Note: Use the same list of sub-parameters inside your "create" parameter as specified on Create an event. You can create up to 100 events at a time.
Request
curl "https://api.timelyapp.com/1.1/61/bulk/events" -d '{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:12.040+02:00","to":"2021-04-29T21:19:12.040+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":131,"account_id":61,"project_id":35}]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TuhKhr0eD2iB7DkJe3lid-d-YG3QSa6HS4J1WT-l2Ko" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/61/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer TuhKhr0eD2iB7DkJe3lid-d-YG3QSa6HS4J1WT-l2Ko
Parameters
{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-29T17:49:12.040+02:00","to":"2021-04-29T21:19:12.040+02:00","day":"2021-04-29","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":131,"account_id":61,"project_id":35}]}
| Name | Description |
|---|---|
| create | Specifies the parameters for creating a group of events. Example: [{ "hours": 3, "minutes": 30, "seconds": 0, "estimated_hours": 4, "estimated_minutes": 0, "from": "2021-03-04T11:33:36.570+01:00", "to": "2021-03-04T15:03:36.570+01:00", "day": "2021-03-04", "note": "Describe what you worked on here!", "hour_rate": 100, "timer_state": 0, "billed": true, "user_id": 1616, "account_id": 651, "project_id": 620}] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"deleted_ids": [],
"created_ids": [
78
],
"updated_ids": []
}
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/66/events/83" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TPugDrQ1IUeD9VBIm5WIY-BoXiofQT1Egy2OH6d2Hwk" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/events/:id
DELETE /1.1/66/events/83
Accept: application/json
Content-Type: application/json
Authorization: Bearer TPugDrQ1IUeD9VBIm5WIY-BoXiofQT1Egy2OH6d2Hwk
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
{}
Delete bulk events
Note: You can delete up to 100 events at a time.
Request
curl "https://api.timelyapp.com/1.1/65/bulk/events" -d '{"delete":[82]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 87YFb2uMwe4OnP0IOhqE563NRvmQEUQCA09A5Gnwfgk" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/65/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 87YFb2uMwe4OnP0IOhqE563NRvmQEUQCA09A5Gnwfgk
Parameters
{"delete":[82]}
| Name | Description |
|---|---|
| delete | Specifies the parameters for deleting a group of events. Example: [ 320, 333 ] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"deleted_ids": [
82
],
"created_ids": [],
"updated_ids": []
}
List all events
Get all events linked to active projects on a user’s account.
Note: If “filter” param is not passed, the default returns current users's logged events, filter=planned returns planned events and filter=all returns logged and planned events.
Request
curl -g "https://api.timelyapp.com/1.1/70/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer oSJ9Ra0a8wxFlYaUn2l5LLYJyoUxpc5vBSEVr3i8rBU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events
GET /1.1/70/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer oSJ9Ra0a8wxFlYaUn2l5LLYJyoUxpc5vBSEVr3i8rBU
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 |
| filter | Specifies which records to retrieve (Default logged). Example: filter=logged or filter=planned or filter=all |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 87,
"uid": "c7e1249ffc03eb9ded908c236bd1996d",
"user": {
"id": 149,
"email": "marijaeshkirqy@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/3d23f35ac400260960ece1a327b6d125?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/3d23f35ac400260960ece1a327b6d125?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/3d23f35ac400260960ece1a327b6d125?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3d23f35ac400260960ece1a327b6d125?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/3d23f35ac400260960ece1a327b6d125?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:16+02:00"
},
"project": {
"id": 44,
"active": true,
"account_id": 70,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711357,
"external_id": null,
"budget_scope": null,
"client": {
"id": 45,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:17+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"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": 1619711357,
"created_at": 1619711357,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:17+02:00",
"from": "2021-04-29T17:49:17+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,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
]
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/72/projects/46/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer H7OvDIR2GyoTQEGQdj1OgZ8yVbn0jKlLnPspBfT13qI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:project_id/events
GET /1.1/72/projects/46/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer H7OvDIR2GyoTQEGQdj1OgZ8yVbn0jKlLnPspBfT13qI
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": 89,
"uid": "7647966b7343c29048673252e490f736",
"user": {
"id": 153,
"email": "marijangsfazka@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/2abfbd60b27beac00221ee4fb94ecee1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/2abfbd60b27beac00221ee4fb94ecee1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/2abfbd60b27beac00221ee4fb94ecee1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/2abfbd60b27beac00221ee4fb94ecee1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/2abfbd60b27beac00221ee4fb94ecee1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:17+02:00"
},
"project": {
"id": 46,
"active": true,
"account_id": 72,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711358,
"external_id": null,
"budget_scope": null,
"client": {
"id": 47,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:18+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"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": 1619711358,
"created_at": 1619711358,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:18+02:00",
"from": "2021-04-29T17:49:18+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,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
]
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/71/users/151/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jKCB59Nw934pSt1McTbSS9YIAGiBFVK24bzDZXjla9M" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/events
GET /1.1/71/users/151/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer jKCB59Nw934pSt1McTbSS9YIAGiBFVK24bzDZXjla9M
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": 88,
"uid": "2a38a4a9316c49e5a833517c45d31070",
"user": {
"id": 151,
"email": "marijagbvhngro@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/b64c22652f0767362c168ed18e975eac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/b64c22652f0767362c168ed18e975eac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/b64c22652f0767362c168ed18e975eac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/b64c22652f0767362c168ed18e975eac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/b64c22652f0767362c168ed18e975eac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:17+02:00"
},
"project": {
"id": 45,
"active": true,
"account_id": 71,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711357,
"external_id": null,
"budget_scope": null,
"client": {
"id": 46,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:17+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"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": 1619711357,
"created_at": 1619711357,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:17+02:00",
"from": "2021-04-29T17:49:17+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,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
]
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/78/users/165/events/95" -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 o-WFHrj-bCUt10uuP8d5BLf2xl5Uxn__G1-qzYjnsVk" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:user_id/events/:id
PUT /1.1/78/users/165/events/95
Accept: application/json
Content-Type: application/json
Authorization: Bearer o-WFHrj-bCUt10uuP8d5BLf2xl5Uxn__G1-qzYjnsVk
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": 95,
"uid": "812b4ba287f5ee0bc9d43bbf5bbe87fb",
"user": {
"id": 165,
"email": "marijabnngxvos@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/0e5c5ad540de1279d27d860ca6a8b554?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0e5c5ad540de1279d27d860ca6a8b554?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/0e5c5ad540de1279d27d860ca6a8b554?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0e5c5ad540de1279d27d860ca6a8b554?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/0e5c5ad540de1279d27d860ca6a8b554?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:21+02:00"
},
"project": {
"id": 52,
"active": true,
"account_id": 78,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711361,
"external_id": null,
"budget_scope": null,
"client": {
"id": 53,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:21+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 10000,
"formatted": "$100.00",
"amount": 100.0
},
"day": "2021-04-29",
"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": 1619711362,
"created_at": 1619711361,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:21+02:00",
"from": "2021-04-29T17:49:21+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 165,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Loggedin user updating details and project of their event
Request
curl "https://api.timelyapp.com/1.1/77/projects/51/events/94" -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 rfKrNf34MC849PjDeT4iKfZD_SvoBpx0iyxi_iYmsI8" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:project_id/events/:id
PUT /1.1/77/projects/51/events/94
Accept: application/json
Content-Type: application/json
Authorization: Bearer rfKrNf34MC849PjDeT4iKfZD_SvoBpx0iyxi_iYmsI8
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": 94,
"uid": "f4b9ec30ad9f68f89b29639786cb62ef",
"user": {
"id": 163,
"email": "marijazdawlgnr@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ae6b9a1ca4061787a79e8892945fbe4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ae6b9a1ca4061787a79e8892945fbe4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ae6b9a1ca4061787a79e8892945fbe4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ae6b9a1ca4061787a79e8892945fbe4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ae6b9a1ca4061787a79e8892945fbe4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:20+02:00"
},
"project": {
"id": 51,
"active": true,
"account_id": 77,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711361,
"external_id": null,
"budget_scope": null,
"client": {
"id": 52,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:21+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 10000,
"formatted": "$100.00",
"amount": 100.0
},
"day": "2021-04-29",
"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": 1619711361,
"created_at": 1619711361,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:21+02:00",
"from": "2021-04-29T17:49:21+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 163,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Retrieve an event
Request
curl -g "https://api.timelyapp.com/1.1/69/events/86" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ujc_dysrCPBzG9ZKmp58LKZzzcVgL37pkl08_XKnMC0" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events/:id
GET /1.1/69/events/86
Accept: application/json
Content-Type: application/json
Authorization: Bearer ujc_dysrCPBzG9ZKmp58LKZzzcVgL37pkl08_XKnMC0
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": 86,
"uid": "93db85ed909c13838ff95ccfa94cebd9",
"user": {
"id": 147,
"email": "marijafykfqbav@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/93c49055bc36dd9a47afabcc55f34b36?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/93c49055bc36dd9a47afabcc55f34b36?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/93c49055bc36dd9a47afabcc55f34b36?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/93c49055bc36dd9a47afabcc55f34b36?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/93c49055bc36dd9a47afabcc55f34b36?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:16+02:00"
},
"project": {
"id": 43,
"active": true,
"account_id": 69,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711356,
"external_id": null,
"budget_scope": null,
"client": {
"id": 44,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:16+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"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": 1619711356,
"created_at": 1619711356,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:16+02:00",
"from": "2021-04-29T17:49:16+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,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Start timer on an event
Request
curl "https://api.timelyapp.com/1.1/73/events/90/start" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer R0gNHTu2cbekATFTZCpDuKyXPDR6IftcrCxO5FF3o18" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/start
PUT /1.1/73/events/90/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer R0gNHTu2cbekATFTZCpDuKyXPDR6IftcrCxO5FF3o18
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 90,
"uid": "8613985ec49eb8f757ae6439e879bb2a",
"user": {
"id": 155,
"email": "marijadtjwqpip@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/0b0b7dfb987b8d35df24391179f7af9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0b0b7dfb987b8d35df24391179f7af9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/0b0b7dfb987b8d35df24391179f7af9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0b0b7dfb987b8d35df24391179f7af9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/0b0b7dfb987b8d35df24391179f7af9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:18+02:00"
},
"project": {
"id": 47,
"active": true,
"account_id": 73,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711359,
"external_id": null,
"budget_scope": null,
"client": {
"id": 48,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:18+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "start",
"timer_started_on": 1619711359,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1619711359,
"created_at": 1619711358,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:18+02:00",
"from": "2021-04-29T17:49:18+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 155,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Stop timer on an event
Request
curl "https://api.timelyapp.com/1.1/74/events/91/stop" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 1Pwe9ySIh8zfTu2tqj6lxZSsjSOP2esYK1r8y_N0CQY" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/stop
PUT /1.1/74/events/91/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1Pwe9ySIh8zfTu2tqj6lxZSsjSOP2esYK1r8y_N0CQY
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 91,
"uid": "54229abfcfa5649e7003b83dd4755294",
"user": {
"id": 157,
"email": "marijanxpxkwav@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/a3d0ee05fda840e779e8bd26cf69931c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/a3d0ee05fda840e779e8bd26cf69931c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/a3d0ee05fda840e779e8bd26cf69931c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/a3d0ee05fda840e779e8bd26cf69931c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/a3d0ee05fda840e779e8bd26cf69931c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:19+02:00"
},
"project": {
"id": 48,
"active": true,
"account_id": 74,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711359,
"external_id": null,
"budget_scope": null,
"client": {
"id": 49,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:19+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": "2021-04-29",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "stop",
"timer_started_on": 0,
"timer_stopped_on": 1619711359,
"label_ids": [],
"user_ids": [],
"updated_at": 1619711359,
"created_at": 1619711359,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:19+02:00",
"from": "2021-04-29T17:49:19+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 157,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
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/76/events/93" -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 SUu-J3iZ2QlRkZgdS1j0uwIAjJVzeokd-dthY8yETe8" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id
PUT /1.1/76/events/93
Accept: application/json
Content-Type: application/json
Authorization: Bearer SUu-J3iZ2QlRkZgdS1j0uwIAjJVzeokd-dthY8yETe8
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 |
| billed | Specifies whether you want an event to be marked as billed. For example: 'billed': false or 'billed': true |
| billable | Specifies whether you want an event to be billable or non-billable. For example: 'billable': false or 'billable': true |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 93,
"uid": "98dce83da57b0395e163467c9dae521b",
"user": {
"id": 161,
"email": "marijafmzaiufk@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/f8002bffc63b45e320b395343ef4bdc7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/f8002bffc63b45e320b395343ef4bdc7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/f8002bffc63b45e320b395343ef4bdc7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/f8002bffc63b45e320b395343ef4bdc7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/f8002bffc63b45e320b395343ef4bdc7?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:20+02:00"
},
"project": {
"id": 50,
"active": true,
"account_id": 76,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711360,
"external_id": null,
"budget_scope": null,
"client": {
"id": 51,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:20+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 10000,
"formatted": "$100.00",
"amount": 100.0
},
"day": "2021-04-29",
"note": "Updated notes",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1619711360,
"created_at": 1619711360,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2021-04-29T21:19:20+02:00",
"from": "2021-04-29T17:49:20+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 161,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Update bulk events
Note: Use the same list of sub-parameters inside your "update" parameter as specified on Update an event. You can update up to 100 events at a time.
Request
curl "https://api.timelyapp.com/1.1/75/bulk/events" -d '{"update":[{"id":92,"note":"updated","billed":true}]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer prvYuhUmnMoZasVk-Z4BsDh85YMhJvH6-qNJN0-9I6g" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/75/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer prvYuhUmnMoZasVk-Z4BsDh85YMhJvH6-qNJN0-9I6g
Parameters
{"update":[{"id":92,"note":"updated","billed":true}]}
| Name | Description |
|---|---|
| update | Specifies the parameters for updating a group of events. Example: [{ "id": 1055, "note": "updated", "billed": true }] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"deleted_ids": [],
"created_ids": [],
"updated_ids": []
}
Forecasts (beta)
Forecasts (currently in beta as "Planning") lets you visualize upcoming work for all Timely users in one clean calendar view. You can then quickly assign work or edit plans across your different projects and teams.
Create a forecast
Request
curl "https://api.timelyapp.com/1.1/108/forecasts" -d '{"from":"2019-05-10","to":"2019-05-16","forecasts":{"note":"Note","from":"2019-05-10","to":"2019-05-16","hours":6,"minutes":0,"has_drafts":true,"user_id":224,"project_id":65}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer L_hxk9HqhR_11uukHvG7J4QyaZqgEHnWxsQxsL0yi5g" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/forecasts
POST /1.1/108/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer L_hxk9HqhR_11uukHvG7J4QyaZqgEHnWxsQxsL0yi5g
Parameters
{"from":"2019-05-10","to":"2019-05-16","forecasts":{"note":"Note","from":"2019-05-10","to":"2019-05-16","hours":6,"minutes":0,"has_drafts":true,"user_id":224,"project_id":65}}
| Name | Description |
|---|---|
| hours required | Forecast hours |
| minutes required | Forecast minutes |
| note | Specifies notes for a forecast |
| 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" |
| user_id required | The numerical ID of the desired user. Example values: 123 |
| project_id required | The numerical ID of the desired project. Example values: 123 |
| label_ids | Specifies label IDs for a forecast. Example values: label_ids:[2,3,4] |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 9,
"note": "Note",
"from": "2019-05-10",
"to": "2019-05-16",
"user": {
"id": 224,
"email": "marijahyecafph@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/020d1a085bba7633212cfe676913c722?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/020d1a085bba7633212cfe676913c722?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/020d1a085bba7633212cfe676913c722?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/020d1a085bba7633212cfe676913c722?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/020d1a085bba7633212cfe676913c722?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:31+02:00",
"weekly_capacity": 40.0,
"weekdays": "MO,TU,WE,TH,FR"
},
"project": {
"id": 65,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 74,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:31+02:00"
},
"updated_at": "2021-04-29T17:49:32+02:00"
},
"hours": 6,
"minutes": 0,
"duration": {
"hours": 6,
"minutes": 0,
"seconds": 0,
"formatted": "06:00",
"total_hours": 6.0,
"total_seconds": 21600,
"total_minutes": 360
},
"daily_duration": {
"hours": 6,
"minutes": 0,
"seconds": 0,
"formatted": "06:00",
"total_hours": 6.0,
"total_seconds": 21600,
"total_minutes": 360
},
"updated_at": "2021-04-29T17:49:31+02:00",
"created_at": "2021-04-29T17:49:31+02:00",
"label_ids": [],
"estimated_duration": {
"hours": 30,
"minutes": 0,
"seconds": 0,
"formatted": "30:00",
"total_hours": 30.0,
"total_seconds": 108000,
"total_minutes": 1800
},
"planned_duration": {
"hours": 42,
"minutes": 0,
"seconds": 0,
"formatted": "42:00",
"total_hours": 42.0,
"total_seconds": 151200,
"total_minutes": 2520
},
"logged_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"completed": false,
"completed_at": null
}
Delete a forecast
Request
curl "https://api.timelyapp.com/1.1/109/forecasts/10" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 2E-I4ONQhRkmM3UVvFp_R-F448URAMYaz60JzndD_uQ" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/forecasts/:id
DELETE /1.1/109/forecasts/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2E-I4ONQhRkmM3UVvFp_R-F448URAMYaz60JzndD_uQ
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the forecast you want to delete |
| id required | The ID for the forecast you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{}
List all forecasts
Request
curl -g "https://api.timelyapp.com/1.1/110/forecasts" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Mv8AijsVt_qX5lfNVVD2OJvjXw8kHxala3woYdDXGSk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/forecasts
GET /1.1/110/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer Mv8AijsVt_qX5lfNVVD2OJvjXw8kHxala3woYdDXGSk
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the forecasts you want to retrieve |
| user_id | The user ID for the forecasts 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 |
| forecast_ids | Specifies the forecasts for which you want results. Numerical forecast IDs should separated by a comma, like so: "user_ids": "175551,117861" |
| user_ids | Specifies the users for which you want results. Numerical user IDs should separated by a comma, like so: "user_ids": "175551,117861" |
| project_ids | Specifies the projects for which you want results. Numerical project IDs should be separated by a comma, like so: "project_ids": "1751,1171" |
| page | Page number (Default 1) |
| per_page | Records per page (Default 50) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 11,
"note": "note",
"from": "2021-04-26",
"to": "2021-05-02",
"user": {
"id": 228,
"email": "marijaooqeyqzz@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/829684b31ad1bb024af7adf940be0c2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/829684b31ad1bb024af7adf940be0c2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/829684b31ad1bb024af7adf940be0c2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/829684b31ad1bb024af7adf940be0c2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/829684b31ad1bb024af7adf940be0c2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:32+02:00",
"weekly_capacity": 40.0,
"weekdays": "MO,TU,WE,TH,FR"
},
"project": {
"id": 67,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 76,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:33+02:00"
},
"updated_at": "2021-04-29T17:49:33+02:00"
},
"hours": 6,
"minutes": 0,
"duration": {
"hours": 6,
"minutes": 0,
"seconds": 0,
"formatted": "06:00",
"total_hours": 6.0,
"total_seconds": 21600,
"total_minutes": 360
},
"daily_duration": {
"hours": 6,
"minutes": 0,
"seconds": 0,
"formatted": "06:00",
"total_hours": 6.0,
"total_seconds": 21600,
"total_minutes": 360
},
"updated_at": "2021-04-29T17:49:33+02:00",
"created_at": "2021-04-29T17:49:33+02:00",
"label_ids": [],
"estimated_duration": {
"hours": 30,
"minutes": 0,
"seconds": 0,
"formatted": "30:00",
"total_hours": 30.0,
"total_seconds": 108000,
"total_minutes": 1800
},
"planned_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"logged_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"completed": false,
"completed_at": null
}
]
Update a forecast
Request
curl "https://api.timelyapp.com/1.1/111/forecasts/12" -d '{"forecasts":{"note":"new note","from":"2019-05-10","to":"2019-05-16","hours":2,"minutes":0,"has_drafts":true,"user_id":230,"project_id":68}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer pzRibrt8sVRZac2m-dolVy-NQ4BmOEWxj8nVMDt3uvY" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/forecasts/:id
PUT /1.1/111/forecasts/12
Accept: application/json
Content-Type: application/json
Authorization: Bearer pzRibrt8sVRZac2m-dolVy-NQ4BmOEWxj8nVMDt3uvY
Parameters
{"forecasts":{"note":"new note","from":"2019-05-10","to":"2019-05-16","hours":2,"minutes":0,"has_drafts":true,"user_id":230,"project_id":68}}
| Name | Description |
|---|---|
| id required | Forecast ID |
| hours required | Forecast hours |
| minutes required | Forecast minutes |
| note | Specifies notes for a forecast |
| 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" |
| user_id required | The numerical ID of the desired user. Example values: 123 |
| project_id required | The numerical ID of the desired project. Example values: 123 |
| label_ids | Specifies label IDs for a forecast. Example values: label_ids:[2,3,4] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 12,
"note": "new note",
"from": "2019-05-10",
"to": "2019-05-16",
"user": {
"id": 230,
"email": "marijanyysuvld@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ad5344429c3acce746cfc18a4daeef0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ad5344429c3acce746cfc18a4daeef0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ad5344429c3acce746cfc18a4daeef0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ad5344429c3acce746cfc18a4daeef0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ad5344429c3acce746cfc18a4daeef0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-29T17:49:33+02:00",
"weekly_capacity": 40.0,
"weekdays": "MO,TU,WE,TH,FR"
},
"project": {
"id": 68,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 77,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:33+02:00"
},
"updated_at": "2021-04-29T17:49:33+02:00"
},
"hours": 2,
"minutes": 0,
"duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"daily_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"updated_at": "2021-04-29T17:49:33+02:00",
"created_at": "2021-04-29T17:49:33+02:00",
"label_ids": [],
"estimated_duration": {
"hours": 10,
"minutes": 0,
"seconds": 0,
"formatted": "10:00",
"total_hours": 10.0,
"total_seconds": 36000,
"total_minutes": 600
},
"planned_duration": {
"hours": 14,
"minutes": 0,
"seconds": 0,
"formatted": "14:00",
"total_hours": 14.0,
"total_seconds": 50400,
"total_minutes": 840
},
"logged_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"completed": false,
"completed_at": 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/149/labels" -d '{"name":null,"label":{"name":"Web Programming","active":true}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 5zN3fDyfZvdWR2KAZLtiPLwkR_8ivRwZiSUUtw_fbnY" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/labels
POST /1.1/149/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5zN3fDyfZvdWR2KAZLtiPLwkR_8ivRwZiSUUtw_fbnY
Parameters
{"name":null,"label":{"name":"Web Programming","active":true}}
| 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 |
| active | Example values: "true" or "false". Using "false" changes the label state to "archived" |
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",
"active": true,
"children": []
}
Delete a label
Request
curl "https://api.timelyapp.com/1.1/150/labels/2" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer k6mv_ilLOjqAaCHg-I9O8mIJ1zdRguE_spx5LcBjbzE" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/labels/:id
DELETE /1.1/150/labels/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer k6mv_ilLOjqAaCHg-I9O8mIJ1zdRguE_spx5LcBjbzE
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/153/labels?parent_id=4" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer d3lIzGOEYKCUQ_KDEuXZFqMBAeZ9vMNsOuQNNoCdvG0" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/153/labels?parent_id=4
Accept: application/json
Content-Type: application/json
Authorization: Bearer d3lIzGOEYKCUQ_KDEuXZFqMBAeZ9vMNsOuQNNoCdvG0
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,
"active": true,
"children": []
}
List all labels
Get all the tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/152/labels" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer H6ru2LWtl1F9a3Xp_tsAVt-I6tlDnPPQAAdw-pGCg84" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/152/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer H6ru2LWtl1F9a3Xp_tsAVt-I6tlDnPPQAAdw-pGCg84
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the label you want to. retrieve |
| offset | Retrieve labels from offset |
| limit | Retrieve number of labels |
| filter | Specifies which records to retrieve. The default shows a current workspace’s all labels (filter=all). Example: "filter=all" or "filter=active" or "filter=archived" |
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/151/labels/3" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer MMQleAs9iEKX-UMp953-ug9RXqaQXf-cJguge43d2mQ" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels/:id
GET /1.1/151/labels/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer MMQleAs9iEKX-UMp953-ug9RXqaQXf-cJguge43d2mQ
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,
"active": true,
"children": []
}
Update a label
Request
curl "https://api.timelyapp.com/1.1/154/labels/5" -d '{"name":null,"label":{"name":"updated name"}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sUi-p-_u3dw46ncwrSVhk02IyeWqQ5BGj41WBlHyQcA" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/labels/:id
PUT /1.1/154/labels/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer sUi-p-_u3dw46ncwrSVhk02IyeWqQ5BGj41WBlHyQcA
Parameters
{"name":null,"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 |
| active | Example values: "true" or "false". Using "false" changes the label state to "archived" |
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",
"active": true,
"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/165/users/current/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer CcebBNyvPw5AtK9Dhnywa39jNmIJPpchgtWH_qKqeZg" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current/permissions
GET /1.1/165/users/current/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer CcebBNyvPw5AtK9Dhnywa39jNmIJPpchgtWH_qKqeZg
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"
]
},
{
"resource": "invoice",
"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/166/users/337/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sbOBHriwjtlTlgtvXg5y2E3VrPa0uDqlDNMOgH27rVs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/permissions
GET /1.1/166/users/337/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer sbOBHriwjtlTlgtvXg5y2E3VrPa0uDqlDNMOgH27rVs
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"
]
},
{
"resource": "invoice",
"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/172/projects" -d '{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","enable_labels":"all","client_id":120,"budget_type":"M","budget":300,"users":[{"user_id":349}],"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":null}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer qOUoHbEFQ6gnL1t7pTha3rLTOG6jpsxshfQ7UGhEf7o" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects
POST /1.1/172/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer qOUoHbEFQ6gnL1t7pTha3rLTOG6jpsxshfQ7UGhEf7o
Parameters
{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","enable_labels":"all","client_id":120,"budget_type":"M","budget":300,"users":[{"user_id":349}],"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":null}
| Name | Description |
|---|---|
| project required | Project attributes |
| name required | Specifies the project name |
| color required | Specifies the project color. Example values: 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 |
| required_labels | Project hours with atleast one label 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 }] |
| enable_labels | Specifies the way labels will be allowed for logging for the project. It should be “all”, “none” or “custom” |
| invoice_by_budget | Specifies if the project's invoices are based on its budget instead of hours. It should be “true“ or “false“ |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 101,
"active": true,
"account_id": 172,
"name": "New Project",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711397,
"external_id": null,
"budget_scope": null,
"client": {
"id": 120,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:57+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": true,
"enable_labels": "all",
"budget": 300,
"budget_type": "M",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"users": [
{
"user_id": 349,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2021-04-29T17:49:57+02:00",
"created_at": "2021-04-29T17:49:57+02:00",
"deleted": false
}
],
"labels": [
{
"project_id": 101,
"label_id": 6,
"budget": 0,
"required": true,
"updated_at": "2021-04-29T21:19:57+05:30"
},
{
"project_id": 101,
"label_id": 7,
"budget": 0,
"required": true,
"updated_at": "2021-04-29T21:19:57+05:30"
},
{
"project_id": 101,
"label_id": 8,
"budget": 0,
"required": false,
"updated_at": "2021-04-29T21:19:57+05:30"
},
{
"project_id": 101,
"label_id": 9,
"budget": 0,
"required": false,
"updated_at": "2021-04-29T21:19:57+05:30"
}
],
"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": "2021-04-29T17:49:57+02:00"
}
}
Delete a project
Request
curl "https://api.timelyapp.com/1.1/173/projects/102" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ip9IN718QDXjVUM62QBt1YDHlqFlHEgEugIN0o6f7XI" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/projects/:id
DELETE /1.1/173/projects/102
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ip9IN718QDXjVUM62QBt1YDHlqFlHEgEugIN0o6f7XI
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/175/projects" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer U_SGsw4JvBLfPAFquqU8MEoPxvaoo1-qI-C4wNxERwA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects
GET /1.1/175/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer U_SGsw4JvBLfPAFquqU8MEoPxvaoo1-qI-C4wNxERwA
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": 104,
"active": true,
"account_id": 175,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711399,
"external_id": null,
"budget_scope": null,
"client": {
"id": 123,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:59+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"users": [
{
"user_id": 355,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2021-04-29T17:49:59+02:00",
"created_at": "2021-04-29T17:49:59+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/174/projects/103" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer rstwAMBvK0HO741mvKFWXc7f-9Lz-IiBbAYjZiV9Bxw" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:id
GET /1.1/174/projects/103
Accept: application/json
Content-Type: application/json
Authorization: Bearer rstwAMBvK0HO741mvKFWXc7f-9Lz-IiBbAYjZiV9Bxw
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": 103,
"active": true,
"account_id": 174,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711398,
"external_id": null,
"budget_scope": null,
"client": {
"id": 122,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:49:58+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"users": [
{
"user_id": 353,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2021-04-29T17:49:58+02:00",
"created_at": "2021-04-29T17:49:58+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/177/projects/106" -d '{"project":{"name":"updated project name"},"name":null}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 7eWCQrguimNv2bq-eglyyDennqytBOImBpSz96Ht0pg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:id
PUT /1.1/177/projects/106
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7eWCQrguimNv2bq-eglyyDennqytBOImBpSz96Ht0pg
Parameters
{"project":{"name":"updated project name"},"name":null}
| 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 |
| required_labels | Project hours with atleast one label to be required for logging |
| enable_labels | Specifies the way labels will be allowed for logging the project. It should be “all”, “none” or “custom” |
| invoice_by_budget | Specifies if the project's invoices are based on its budget instead of hours. It should be “true“ or “false“. |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 106,
"active": true,
"account_id": 177,
"name": "updated project name",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711400,
"external_id": null,
"budget_scope": null,
"client": {
"id": 125,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:50:00+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "none",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"users": [
{
"user_id": 359,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2021-04-29T17:50:00+02:00",
"created_at": "2021-04-29T17:50:00+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
Report on activity across your business, including individual and team performance. Export report data from JSON to a format of your choice. Note: .XLS, .CSV and .PDF report formats can only be downloaded from the web UI, not the API.
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/211/reports" -d '{"user_ids":"460","since":"2018-01-01","until":"2019-01-01","project_ids":"177"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer xDa7MOEgIcAciauCrZ852IAIRoNLK4Sq50xFi7Ekodg" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports
POST /1.1/211/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer xDa7MOEgIcAciauCrZ852IAIRoNLK4Sq50xFi7Ekodg
Parameters
{"user_ids":"460","since":"2018-01-01","until":"2019-01-01","project_ids":"177"}
| 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": 159,
"name": "Timely",
"projects": [
{
"id": 177,
"active": true,
"account_id": 211,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711421,
"external_id": null,
"budget_scope": null,
"client": {
"id": 159,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:50:21+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.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.com/1.1/212/reports/filter" -d '{"user_ids":"462","since":"2018-01-01","until":"2019-01-01","project_ids":"178"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer D6HHCpprk2C5RBlWJd8P7WpSMgOviQBnEW-dC0xyQmc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports/filter
POST /1.1/212/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer D6HHCpprk2C5RBlWJd8P7WpSMgOviQBnEW-dC0xyQmc
Parameters
{"user_ids":"462","since":"2018-01-01","until":"2019-01-01","project_ids":"178"}
| 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] |
| group_by | Specifies how to group the hours. Default: group_by: ["clients", "users", "labels", "days", "teams"] |
| scope | Retrieve events only. For example: 'scope=events' |
| offset | Retrieve records from offset (Default 0). |
| limit | Retrieve number of records. Max 100 records. |
| page | Page number (Default 1). |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"totals": {
"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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
}
},
"clients": [
{
"id": 160,
"name": "Timely",
"projects": [
{
"id": 178,
"active": true,
"account_id": 212,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1619711422,
"external_id": null,
"budget_scope": null,
"client": {
"id": 160,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-29T17:50:22+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"budget_progress": 0.0,
"budget_percent": 0.0,
"invoice_by_budget": false,
"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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
}
}
],
"users": [
{
"id": 462,
"email": "marijasyxofieh@timelyapp.com",
"name": "Marija Petrovic",
"time_zone": "Europe/Paris",
"updated_at": 1619711421,
"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/124db5639df06a943dd16ff9a249e5aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/124db5639df06a943dd16ff9a249e5aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/124db5639df06a943dd16ff9a249e5aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/124db5639df06a943dd16ff9a249e5aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/124db5639df06a943dd16ff9a249e5aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.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",
"active": true,
"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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.0
}
}
],
"teams": [
{
"id": 0,
"name": "No team",
"color": "866b9c",
"emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v4.0.4/img-twitter-64/1f465.png",
"external_id": null,
"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
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
}
}
]
}
Roles
List roles
Note: default attribute shows which role to select by default
Request
curl -g "https://api.timelyapp.com/1.1/213/roles" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer SkJtoQIkJE0ZTnmthz51Ep2AYHCGOG71fR9nCWvPm4Q" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/roles
GET /1.1/213/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer SkJtoQIkJE0ZTnmthz51Ep2AYHCGOG71fR9nCWvPm4Q
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which roles are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 637,
"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": 639,
"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": 638,
"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/235/teams" -d '{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":508,"lead":true},{"user_id":510,"lead":false}]}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer CBbVf5KUR4Q1Qbcop_fjBjSDJ8FGVmTgj-f1KOQyumI" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/teams
POST /1.1/235/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer CBbVf5KUR4Q1Qbcop_fjBjSDJ8FGVmTgj-f1KOQyumI
Parameters
{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":508,"lead":true},{"user_id":510,"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": [
508,
510
],
"users": [
{
"id": 1,
"user_id": 508,
"team_id": 1,
"lead": true
},
{
"id": 2,
"user_id": 510,
"team_id": 1,
"lead": false
}
]
}
Delete a team
Request
curl "https://api.timelyapp.com/1.1/236/teams/2" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer y8b6h4ydNQ9Zi2onqJYj7kzCii_GbIucIat0pvyFGTs" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/teams/:id
DELETE /1.1/236/teams/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer y8b6h4ydNQ9Zi2onqJYj7kzCii_GbIucIat0pvyFGTs
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/238/teams" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer s5YY6ir_cfwRRKYWc4xXeor0-iFh2S_dL5PlA95TnF4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams
GET /1.1/238/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer s5YY6ir_cfwRRKYWc4xXeor0-iFh2S_dL5PlA95TnF4
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/237/teams/3" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer OFWFTBeWD-yp15ypDa0EyH-1tRimY80ueNm3KobTcqM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams/:id
GET /1.1/237/teams/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer OFWFTBeWD-yp15ypDa0EyH-1tRimY80ueNm3KobTcqM
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/239/teams/5" -d '{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":517,"lead":true}]}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 5vOeX0kplrVIoZNiOgIulZ3ArcxPv71ZQbn-msTHZUc" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/teams/:id
PUT /1.1/239/teams/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5vOeX0kplrVIoZNiOgIulZ3ArcxPv71ZQbn-msTHZUc
Parameters
{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":517,"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": [
517
],
"users": [
{
"id": 3,
"user_id": 517,
"team_id": 5,
"lead": true
}
]
}
UserCapacities
Retrieve capacities
See capacities of multiple users in the account
Request
curl -g "https://api.timelyapp.com/1.1/244/users/capacities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer HGUuOUgcJaGcdC6oGoZOkXvGHTxa-ppMjXTYjeVF0PY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/capacities
GET /1.1/244/users/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer HGUuOUgcJaGcdC6oGoZOkXvGHTxa-ppMjXTYjeVF0PY
Parameters
| Name | Description |
|---|---|
| account_id required | Account for which users' capacities are required |
| user_ids | Users whose capacities are required |
| since | Fetch capacities after selected date |
| until | Fetch capacities before selected date |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"user_id": 527,
"capacities": [
{
"id": null,
"weekly_capacity": 40.0,
"daily_capacity": 8.0,
"weekdays": "MO,TU,WE,TH,FR",
"total_working_days": null,
"weekly_working_days": 5,
"current": true,
"start_date": "1970-01-01",
"end_date": null
}
]
}
]
Retrieve user's capacities
Using the user id one can see the user's capacities
Request
curl -g "https://api.timelyapp.com/1.1/243/users/525/capacities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer lt4jkGf44acDwtSFK7RmKbi_uJ37cAV4kNULpzx7zmc" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/capacities
GET /1.1/243/users/525/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer lt4jkGf44acDwtSFK7RmKbi_uJ37cAV4kNULpzx7zmc
Parameters
| Name | Description |
|---|---|
| account_id required | Account for which user's capacities are required |
| user_id required | User whose capacities are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": null,
"weekly_capacity": 40.0,
"daily_capacity": 8.0,
"weekdays": "MO,TU,WE,TH,FR",
"total_working_days": null,
"weekly_working_days": 5,
"current": true,
"start_date": "1970-01-01",
"end_date": null
}
]
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/246/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":211,"hour_rate":10}]},"name":null,"admin":{"id":203,"email":"notifications@timelyapp.com","created_at":"2021-04-29T17:50:41.000+02:00","updated_at":"2021-04-29T17:50:41.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 QdLI9w0C8azBKuj2zUsZwjPG5Bgo6OW1XBLKltHBgKw" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users
POST /1.1/246/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer QdLI9w0C8azBKuj2zUsZwjPG5Bgo6OW1XBLKltHBgKw
Parameters
{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":211,"hour_rate":10}]},"name":null,"admin":{"id":203,"email":"notifications@timelyapp.com","created_at":"2021-04-29T17:50:41.000+02:00","updated_at":"2021-04-29T17:50:41.000+02:00","name":"Timely","notifier":false}}
| Name | Description |
|---|---|
| user required | User 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) |
| weekly_capacity | Specifies the user's weekly hour capacity. The default is account's weekly capacity. To avoid rounding issues, values are allowed upto 1 decimal place and divisible by 5. |
| add_to_all_projects | Specifies whether the user should be added to all projects in the account. For example: "add_to_all_projects":true |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 533,
"email": "marija@timely.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": false,
"memory_onboarded": false,
"created_at": 1619711441,
"updated_at": 1619711441,
"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-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"weekly_capacity": 40.0,
"user_level": "manager",
"admin": false,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 737,
"role": {
"id": 737,
"name": "manager"
}
}
Delete a user
Request
curl "https://api.timelyapp.com/1.1/247/users/534" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer kxLUJTvlOubCmkyTjtPEKHbWH5vqOQVE9kFWq4UZNPQ" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/users/:id
DELETE /1.1/247/users/534
Accept: application/json
Content-Type: application/json
Authorization: Bearer kxLUJTvlOubCmkyTjtPEKHbWH5vqOQVE9kFWq4UZNPQ
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/250/users" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer S9mvAvkW23rrmT_dmDFit90ECSNk5RBZA6Nti4YMqWA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users
GET /1.1/250/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer S9mvAvkW23rrmT_dmDFit90ECSNk5RBZA6Nti4YMqWA
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": 540,
"email": "marijadzcvurhn@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1619711443,
"updated_at": 1619711443,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/52042d34a3ae1a78b389d4b0834bc005?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/52042d34a3ae1a78b389d4b0834bc005?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/52042d34a3ae1a78b389d4b0834bc005?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/52042d34a3ae1a78b389d4b0834bc005?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/52042d34a3ae1a78b389d4b0834bc005?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/52042d34a3ae1a78b389d4b0834bc005?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"weekly_capacity": 40.0,
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 748,
"role": {
"id": 748,
"name": "admin"
}
}
]
Retrieve a user
Request
curl -g "https://api.timelyapp.com/1.1/248/users/536" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer abth37Jl6E8uc3iCKNDnYxUU62aBDc5FNqRYRSNaBng" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:id
GET /1.1/248/users/536
Accept: application/json
Content-Type: application/json
Authorization: Bearer abth37Jl6E8uc3iCKNDnYxUU62aBDc5FNqRYRSNaBng
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": 536,
"email": "marijamsbewwrd@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1619711442,
"updated_at": 1619711442,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/133ff1a4e861a4f8f2c28a86be9a6b68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/133ff1a4e861a4f8f2c28a86be9a6b68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/133ff1a4e861a4f8f2c28a86be9a6b68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/133ff1a4e861a4f8f2c28a86be9a6b68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/133ff1a4e861a4f8f2c28a86be9a6b68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/133ff1a4e861a4f8f2c28a86be9a6b68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"weekly_capacity": 40.0,
"active_projects_count": 1,
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 742,
"role": {
"id": 742,
"name": "admin"
}
}
Retrieve current user
Request
curl -g "https://api.timelyapp.com/1.1/249/users/current" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Dwxth3cOaEf7E5TUL40Bqjgn84ad9eqWUFHn30JLA6E" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current
GET /1.1/249/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer Dwxth3cOaEf7E5TUL40Bqjgn84ad9eqWUFHn30JLA6E
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the current user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 538,
"email": "marijaweufarcg@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1619711442,
"updated_at": 1619711442,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/69b14874d4f9cd64f73ec39038c6caa1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/69b14874d4f9cd64f73ec39038c6caa1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/69b14874d4f9cd64f73ec39038c6caa1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/69b14874d4f9cd64f73ec39038c6caa1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/69b14874d4f9cd64f73ec39038c6caa1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/69b14874d4f9cd64f73ec39038c6caa1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"weekly_capacity": 40.0,
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 745,
"role": {
"id": 745,
"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/251/users/542" -d '{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":216,"hour_rate":10}]},"admin":{"id":208,"email":"notifications@timelyapp.com","created_at":"2021-04-29T17:50:44.000+02:00","updated_at":"2021-04-29T17:50:44.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 YzM6HYPZViArKLPSCmBCrKQxduxyvRAvSmLeudiB9_I" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:id
PUT /1.1/251/users/542
Accept: application/json
Content-Type: application/json
Authorization: Bearer YzM6HYPZViArKLPSCmBCrKQxduxyvRAvSmLeudiB9_I
Parameters
{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":216,"hour_rate":10}]},"admin":{"id":208,"email":"notifications@timelyapp.com","created_at":"2021-04-29T17:50:44.000+02:00","updated_at":"2021-04-29T17:50:44.000+02:00","name":"Timely","notifier":false}}
| Name | Description |
|---|---|
| id required | the numerical ID of the user |
| user required | Label attributes |
| 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" |
| weekly_capacity | Specifies the user's weekly hour capacity. The default is the account's weekly capacity. To avoid rounding issues, values are allowed upto 1 decimal place and divisible by 5. |
| add_to_all_projects | Specifies whether the user should be added to all projects in the account. For example: "add_to_all_projects":true |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 542,
"email": "marijazcmgthqt@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1619711443,
"updated_at": 1619711443,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/2e6f2b0823afecfd534c6b838687ef0f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/2e6f2b0823afecfd534c6b838687ef0f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/2e6f2b0823afecfd534c6b838687ef0f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/2e6f2b0823afecfd534c6b838687ef0f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/2e6f2b0823afecfd534c6b838687ef0f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/2e6f2b0823afecfd534c6b838687ef0f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"weekly_capacity": 40.0,
"user_level": "manager",
"admin": false,
"hide_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"role_id": 752,
"role": {
"id": 752,
"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. |