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 jmsYCSG_fTAX5g8loqPa5M2v0xKLWc_kGF5vqnegJds" \
-H "Cookie: "
Endpoint
GET /1.1/accounts
GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer jmsYCSG_fTAX5g8loqPa5M2v0xKLWc_kGF5vqnegJds
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-15",
"start_of_week": 0,
"created_at": 1618466985,
"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
}
]
}
]
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 05yHs-HoZl0U_YiRjYPvOH0vsluPOCYCQ2s4ua_GggA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/activities
GET /1.1/16/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer 05yHs-HoZl0U_YiRjYPvOH0vsluPOCYCQ2s4ua_GggA
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": "marijavszlkhkr@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:09:44+02:00"
},
"message": "archived",
"activity_type": "archive_project",
"url": "http://app.timelyapp.local:3002/16/projects/11",
"updated_at": "2021-04-08T08:09:45+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-15T08:09:45+02:00"
},
"updated_at": "2021-04-15T08:09:45+02:00"
},
"anomaly": false
},
{
"id": 18,
"user": {
"id": 35,
"email": "marijavszlkhkr@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/d333f9d4638667c2247afb6a27c61e49?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:09:44+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-15T08:09:45+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-15T08:09:45+02:00"
},
"updated_at": "2021-04-15T08:09:45+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 hGpMwmHMIgGo9PMYYKBBbJprkj0KlMwG5M981hZqWgo" \
-H "Cookie: "
Endpoint
GET /1.1/accounts/:id
GET /1.1/accounts/17
Accept: application/json
Content-Type: application/json
Authorization: Bearer hGpMwmHMIgGo9PMYYKBBbJprkj0KlMwG5M981hZqWgo
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-15",
"start_of_week": 0,
"created_at": 1618466985,
"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
}
]
}
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 ESJmapiVrGfCKIErzmTbQWubJ_QvrCcO8Sk4QdWnITw" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/clients
POST /1.1/40/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer ESJmapiVrGfCKIErzmTbQWubJ_QvrCcO8Sk4QdWnITw
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-15T08:09:57+02:00"
}
List all clients
Client lists will return your 10 most recently updated clients. Additionally, you can add the “per_page”, “filter” and “order” optional parameters to change the result
NOTE: Client list will return recently updated 10 clients.
Request
curl -g "https://api.timelyapp.com/1.1/41/clients" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 5v1DVcHRi-8-PK0sbowD3M69mTaj3fDdmRl78TPESm8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients
GET /1.1/41/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5v1DVcHRi-8-PK0sbowD3M69mTaj3fDdmRl78TPESm8
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-15T08:09:57+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/42/clients/29" -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 Dljc1-AFK-opBDTIAqAvqqiuiZh6-NHu95qcWPrlVsM" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/clients/:id
PUT /1.1/42/clients/29
Accept: application/json
Content-Type: application/json
Authorization: Bearer Dljc1-AFK-opBDTIAqAvqqiuiZh6-NHu95qcWPrlVsM
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": 29,
"name": "Updated name",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:09:58+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/61/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:06.071+02:00","to":"2021-04-15T11:40:06.071+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":35}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer uh6EY7igd_TzEUKVizj7hjQp5Vl_D-Nmt-8FmSqR0Ww" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/events
POST /1.1/61/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer uh6EY7igd_TzEUKVizj7hjQp5Vl_D-Nmt-8FmSqR0Ww
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:06.071+02:00","to":"2021-04-15T11:40:06.071+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":35}}
| 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": 79,
"uid": "d1fe173d08e959397adf34b1d77e88d7",
"user": {
"id": 131,
"email": "marijagptgbcnh@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/7e57a11795d61e68f4631fa94d164d2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/7e57a11795d61e68f4631fa94d164d2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/7e57a11795d61e68f4631fa94d164d2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/7e57a11795d61e68f4631fa94d164d2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/7e57a11795d61e68f4631fa94d164d2c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:05+02:00"
},
"project": {
"id": 35,
"active": true,
"account_id": 61,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467006,
"external_id": null,
"budget_scope": null,
"client": {
"id": 36,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:06+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": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"day": "2021-04-15",
"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": 1618467006,
"created_at": 1618467006,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:06+02:00",
"from": "2021-04-15T08:10:06+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 131,
"updater_id": 131,
"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/60/projects/34/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:05.484+02:00","to":"2021-04-15T11:40:05.485+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":34}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer PLYV7IaOiCvnqCpMcSyvpz_ajAQSSpnuvzq1QtlnRCo" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects/:project_id/events
POST /1.1/60/projects/34/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer PLYV7IaOiCvnqCpMcSyvpz_ajAQSSpnuvzq1QtlnRCo
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:05.484+02:00","to":"2021-04-15T11:40:05.485+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":34}}
| 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": 78,
"uid": "35f4a8d465e6e1edc05f3d8ab658c551",
"user": {
"id": 129,
"email": "marijabgqnremf@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/a0a1ead5e83a9fe9d015df8a632e7528?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/a0a1ead5e83a9fe9d015df8a632e7528?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/a0a1ead5e83a9fe9d015df8a632e7528?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/a0a1ead5e83a9fe9d015df8a632e7528?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/a0a1ead5e83a9fe9d015df8a632e7528?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:05+02:00"
},
"project": {
"id": 34,
"active": true,
"account_id": 60,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467005,
"external_id": null,
"budget_scope": null,
"client": {
"id": 35,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:05+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": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"day": "2021-04-15",
"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": 1618467005,
"created_at": 1618467005,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:05+02:00",
"from": "2021-04-15T08:10:05+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 129,
"updater_id": 129,
"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/59/users/127/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:04.898+02:00","to":"2021-04-15T11:40:04.898+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":127}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Mo8iiWF52evr9vw22y4dMspbNVMgQNJlQVJOGotwCmU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users/:user_id/events
POST /1.1/59/users/127/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer Mo8iiWF52evr9vw22y4dMspbNVMgQNJlQVJOGotwCmU
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:04.898+02:00","to":"2021-04-15T11:40:04.898+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":127}}
| 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": 77,
"uid": "28dd2c7955ce926456240b2ff0100bde",
"user": {
"id": 127,
"email": "marijaxyvmvyjw@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/3451aec3057c3297d5e8584b487191d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/3451aec3057c3297d5e8584b487191d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/3451aec3057c3297d5e8584b487191d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3451aec3057c3297d5e8584b487191d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/3451aec3057c3297d5e8584b487191d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:04+02:00"
},
"project": {
"id": 33,
"active": true,
"account_id": 59,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467004,
"external_id": null,
"budget_scope": null,
"client": {
"id": 34,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:04+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": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"day": "2021-04-15",
"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": 1618467004,
"created_at": 1618467004,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:04+02:00",
"from": "2021-04-15T08:10:04+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 127,
"updater_id": 127,
"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/58/bulk/events" -d '{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:04.254+02:00","to":"2021-04-15T11:40:04.254+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":125,"account_id":58,"project_id":32}]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer _7f-KzElfRNOOPrZVWwjLPmTwjoMY1o04GqEHsb01Vk" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/58/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer _7f-KzElfRNOOPrZVWwjLPmTwjoMY1o04GqEHsb01Vk
Parameters
{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-04-15T08:10:04.254+02:00","to":"2021-04-15T11:40:04.254+02:00","day":"2021-04-15","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":125,"account_id":58,"project_id":32}]}
| 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": [
76
],
"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/63/events/81" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer MsUz-LB3jQjAGNZKo9h28JNaBXDmRH7LEoQw6OWJkwU" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/events/:id
DELETE /1.1/63/events/81
Accept: application/json
Content-Type: application/json
Authorization: Bearer MsUz-LB3jQjAGNZKo9h28JNaBXDmRH7LEoQw6OWJkwU
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/62/bulk/events" -d '{"delete":[80]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 4anF5_Zb22_pdho2m1_iQKUzWbqgDLavUanFJTZr0VU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/62/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4anF5_Zb22_pdho2m1_iQKUzWbqgDLavUanFJTZr0VU
Parameters
{"delete":[80]}
| 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": [
80
],
"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/67/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer dF0TvVpPmih8HYzDAXxWHea8DFpWwzmXjfDdZgQd-rI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events
GET /1.1/67/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer dF0TvVpPmih8HYzDAXxWHea8DFpWwzmXjfDdZgQd-rI
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": 85,
"uid": "3ef815416f775098fe977004015c6193",
"user": {
"id": 143,
"email": "marijaxiafvdtm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/bef1abe7b4c60f09da01a3655c261a8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/bef1abe7b4c60f09da01a3655c261a8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/bef1abe7b4c60f09da01a3655c261a8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/bef1abe7b4c60f09da01a3655c261a8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/bef1abe7b4c60f09da01a3655c261a8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:08+02:00"
},
"project": {
"id": 41,
"active": true,
"account_id": 67,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467009,
"external_id": null,
"budget_scope": null,
"client": {
"id": 42,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:09+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-15",
"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": 1618467009,
"created_at": 1618467009,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2021-04-15T11:40:09+02:00",
"from": "2021-04-15T08:10:09+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/69/projects/43/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer v2oLcT96X5oat6WUkyZNRXZwaCCKClldxYM745bDNUU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:project_id/events
GET /1.1/69/projects/43/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer v2oLcT96X5oat6WUkyZNRXZwaCCKClldxYM745bDNUU
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": 87,
"uid": "c7e1249ffc03eb9ded908c236bd1996d",
"user": {
"id": 147,
"email": "marijaxrygbftk@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ddddba1e8fd26149d444afd9528a257b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ddddba1e8fd26149d444afd9528a257b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ddddba1e8fd26149d444afd9528a257b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ddddba1e8fd26149d444afd9528a257b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ddddba1e8fd26149d444afd9528a257b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:10+02:00"
},
"project": {
"id": 43,
"active": true,
"account_id": 69,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467010,
"external_id": null,
"budget_scope": null,
"client": {
"id": 44,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:10+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-15",
"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": 1618467010,
"created_at": 1618467010,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2021-04-15T11:40:10+02:00",
"from": "2021-04-15T08:10:10+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/68/users/145/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jodXULiiFiESOhhRj6p7iu2vQkZkPTUgf7u4CXm0s6Q" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/events
GET /1.1/68/users/145/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer jodXULiiFiESOhhRj6p7iu2vQkZkPTUgf7u4CXm0s6Q
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": 86,
"uid": "93db85ed909c13838ff95ccfa94cebd9",
"user": {
"id": 145,
"email": "marijaweeggceq@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/e1866c5e25c82c0a9e2b890ca187b0db?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/e1866c5e25c82c0a9e2b890ca187b0db?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/e1866c5e25c82c0a9e2b890ca187b0db?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/e1866c5e25c82c0a9e2b890ca187b0db?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/e1866c5e25c82c0a9e2b890ca187b0db?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:09+02:00"
},
"project": {
"id": 42,
"active": true,
"account_id": 68,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467010,
"external_id": null,
"budget_scope": null,
"client": {
"id": 43,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:10+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-15",
"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": 1618467010,
"created_at": 1618467010,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2021-04-15T11:40:10+02:00",
"from": "2021-04-15T08:10:10+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/75/users/159/events/93" -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 KkYkAzDtJAIxXw-AMpLOQFVHCdvw9x6MHmvozNJbb24" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:user_id/events/:id
PUT /1.1/75/users/159/events/93
Accept: application/json
Content-Type: application/json
Authorization: Bearer KkYkAzDtJAIxXw-AMpLOQFVHCdvw9x6MHmvozNJbb24
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": 93,
"uid": "98dce83da57b0395e163467c9dae521b",
"user": {
"id": 159,
"email": "marijadfgwckwe@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/bdff2ed68cbdb0db00e59aa212569d1f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/bdff2ed68cbdb0db00e59aa212569d1f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/bdff2ed68cbdb0db00e59aa212569d1f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/bdff2ed68cbdb0db00e59aa212569d1f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/bdff2ed68cbdb0db00e59aa212569d1f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:13+02:00"
},
"project": {
"id": 49,
"active": true,
"account_id": 75,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467014,
"external_id": null,
"budget_scope": null,
"client": {
"id": 50,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:14+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": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2021-04-15",
"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": 1618467014,
"created_at": 1618467014,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:14+02:00",
"from": "2021-04-15T08:10:14+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 159,
"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/74/projects/48/events/92" -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 7SrVJiPaGJcWsd7UypdzPBLFGTDfI9hHy-t90rM-C_o" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:project_id/events/:id
PUT /1.1/74/projects/48/events/92
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7SrVJiPaGJcWsd7UypdzPBLFGTDfI9hHy-t90rM-C_o
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": 92,
"uid": "92cc227532d17e56e07902b254dfad10",
"user": {
"id": 157,
"email": "marijafhgtjzqj@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/bd99ed7b6c6b76d371fd35679b15c0af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/bd99ed7b6c6b76d371fd35679b15c0af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/bd99ed7b6c6b76d371fd35679b15c0af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/bd99ed7b6c6b76d371fd35679b15c0af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/bd99ed7b6c6b76d371fd35679b15c0af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:13+02:00"
},
"project": {
"id": 48,
"active": true,
"account_id": 74,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467013,
"external_id": null,
"budget_scope": null,
"client": {
"id": 49,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10: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": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2021-04-15",
"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": 1618467013,
"created_at": 1618467013,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:13+02:00",
"from": "2021-04-15T08:10:13+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": [
]
}
Retrieve an event
Request
curl -g "https://api.timelyapp.com/1.1/66/events/84" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer NPGe5AZWmdG83JM0A9UbV1jLdZpy47-f3mtEwd6LHdk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events/:id
GET /1.1/66/events/84
Accept: application/json
Content-Type: application/json
Authorization: Bearer NPGe5AZWmdG83JM0A9UbV1jLdZpy47-f3mtEwd6LHdk
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": 84,
"uid": "68d30a9594728bc39aa24be94b319d21",
"user": {
"id": 141,
"email": "marijamwzyeonh@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/03672267f527604637c117d821c38f11?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/03672267f527604637c117d821c38f11?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/03672267f527604637c117d821c38f11?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/03672267f527604637c117d821c38f11?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/03672267f527604637c117d821c38f11?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:08+02:00"
},
"project": {
"id": 40,
"active": true,
"account_id": 66,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467008,
"external_id": null,
"budget_scope": null,
"client": {
"id": 41,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:08+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-15",
"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": 1618467008,
"created_at": 1618467008,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2021-04-15T11:40:08+02:00",
"from": "2021-04-15T08:10:08+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/70/events/88/start" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jH1j7h97kRlNsI8TnKbOAz7hqnmQ5kwtxYRvts9kOjs" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/start
PUT /1.1/70/events/88/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer jH1j7h97kRlNsI8TnKbOAz7hqnmQ5kwtxYRvts9kOjs
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 88,
"uid": "2a38a4a9316c49e5a833517c45d31070",
"user": {
"id": 149,
"email": "marijahldqcizc@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/a75aac91aa44e12401bca905261ef99f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/a75aac91aa44e12401bca905261ef99f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/a75aac91aa44e12401bca905261ef99f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/a75aac91aa44e12401bca905261ef99f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/a75aac91aa44e12401bca905261ef99f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:10+02:00"
},
"project": {
"id": 44,
"active": true,
"account_id": 70,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467011,
"external_id": null,
"budget_scope": null,
"client": {
"id": 45,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:11+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-15",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "start",
"timer_started_on": 1618467011,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1618467011,
"created_at": 1618467011,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:11+02:00",
"from": "2021-04-15T08:10:11+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 149,
"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/71/events/89/stop" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 4FsPt_tUIeRBJutCojQoPVLsyxDTQleitNr6RAOja34" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/stop
PUT /1.1/71/events/89/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4FsPt_tUIeRBJutCojQoPVLsyxDTQleitNr6RAOja34
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 89,
"uid": "7647966b7343c29048673252e490f736",
"user": {
"id": 151,
"email": "marijatlnunxdi@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/714714579c86b0bc21cadae4d55318aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/714714579c86b0bc21cadae4d55318aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/714714579c86b0bc21cadae4d55318aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/714714579c86b0bc21cadae4d55318aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/714714579c86b0bc21cadae4d55318aa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:11+02:00"
},
"project": {
"id": 45,
"active": true,
"account_id": 71,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467011,
"external_id": null,
"budget_scope": null,
"client": {
"id": 46,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:11+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-15",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "stop",
"timer_started_on": 0,
"timer_stopped_on": 1618467011,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1618467011,
"created_at": 1618467011,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:11+02:00",
"from": "2021-04-15T08:10:11+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 151,
"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/73/events/91" -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 8sxzbztJav-gaANRkhx-melyAHIe8QvOHeUyr1-M_QY" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id
PUT /1.1/73/events/91
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8sxzbztJav-gaANRkhx-melyAHIe8QvOHeUyr1-M_QY
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 |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 91,
"uid": "54229abfcfa5649e7003b83dd4755294",
"user": {
"id": 155,
"email": "marijabngewbqg@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8364d015d8253f627e62d2c16960e886?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8364d015d8253f627e62d2c16960e886?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/8364d015d8253f627e62d2c16960e886?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8364d015d8253f627e62d2c16960e886?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/8364d015d8253f627e62d2c16960e886?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:12+02:00"
},
"project": {
"id": 47,
"active": true,
"account_id": 73,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467013,
"external_id": null,
"budget_scope": null,
"client": {
"id": 48,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10: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": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2021-04-15",
"note": "Updated notes",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1618467013,
"created_at": 1618467013,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2021-04-15T11:40:13+02:00",
"from": "2021-04-15T08:10:13+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": [
]
}
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/72/bulk/events" -d '{"update":[{"id":90,"note":"updated","billed":true}]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 09urBifUUxKoZzaNFu0LBsNaTQy6AUdQBEqDMWVd4Y0" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/72/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 09urBifUUxKoZzaNFu0LBsNaTQy6AUdQBEqDMWVd4Y0
Parameters
{"update":[{"id":90,"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": [
90
]
}
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/105/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":218,"project_id":62}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jkhhgaB75uv4Rdhc5lbghz8sLXE4-yiQrwvY9tB95Wg" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/forecasts
POST /1.1/105/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer jkhhgaB75uv4Rdhc5lbghz8sLXE4-yiQrwvY9tB95Wg
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":218,"project_id":62}}
| 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": 218,
"email": "marijastmcmdzs@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/290287a47c62c45bdabfd8f8c0936c23?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/290287a47c62c45bdabfd8f8c0936c23?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/290287a47c62c45bdabfd8f8c0936c23?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/290287a47c62c45bdabfd8f8c0936c23?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/290287a47c62c45bdabfd8f8c0936c23?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:23+02:00",
"weekly_capacity": 40.0,
"weekdays": "MO,TU,WE,TH,FR"
},
"project": {
"id": 62,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 71,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:23+02:00"
},
"updated_at": "2021-04-15T08:10:24+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-15T08:10:23+02:00",
"created_at": "2021-04-15T08:10:23+02:00",
"label_ids": [
],
"estimated_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_at": null
}
Delete a forecast
Request
curl "https://api.timelyapp.com/1.1/106/forecasts/10" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer lQ1PiXDNKawwW-jnn-uRDUwZ7RDqGvi6_Zr_iBVN-lQ" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/forecasts/:id
DELETE /1.1/106/forecasts/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer lQ1PiXDNKawwW-jnn-uRDUwZ7RDqGvi6_Zr_iBVN-lQ
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/107/forecasts" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer xu5EW8iQ_zUNLoExg-fDne62LWr_EFwmB_ljoFqnYWA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/forecasts
GET /1.1/107/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer xu5EW8iQ_zUNLoExg-fDne62LWr_EFwmB_ljoFqnYWA
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-12",
"to": "2021-04-18",
"user": {
"id": 222,
"email": "marijapqnegxdn@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ba266452af5538a7c6e2258834f12d8d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ba266452af5538a7c6e2258834f12d8d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ba266452af5538a7c6e2258834f12d8d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ba266452af5538a7c6e2258834f12d8d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ba266452af5538a7c6e2258834f12d8d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:24+02:00",
"weekly_capacity": 40.0,
"weekdays": "MO,TU,WE,TH,FR"
},
"project": {
"id": 64,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 73,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:25+02:00"
},
"updated_at": "2021-04-15T08:10:25+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-15T08:10:25+02:00",
"created_at": "2021-04-15T08:10:25+02:00",
"label_ids": [
],
"estimated_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_at": null
}
]
Update a forecast
Request
curl "https://api.timelyapp.com/1.1/108/forecasts/12" -d '{"forecasts":{"note":"new note","from":"2019-05-10","to":"2019-05-16","hours":2,"minutes":0,"has_drafts":true,"user_id":224,"project_id":65}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer WMzHNfd7O5t5JcDJJ5FBIKQuMkzcQYDwEtNw84kcDQg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/forecasts/:id
PUT /1.1/108/forecasts/12
Accept: application/json
Content-Type: application/json
Authorization: Bearer WMzHNfd7O5t5JcDJJ5FBIKQuMkzcQYDwEtNw84kcDQg
Parameters
{"forecasts":{"note":"new note","from":"2019-05-10","to":"2019-05-16","hours":2,"minutes":0,"has_drafts":true,"user_id":224,"project_id":65}}
| 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": 224,
"email": "marijakybfkemu@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/5cbc044d4ca7c5e7a12bcdbba4e9c7a3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/5cbc044d4ca7c5e7a12bcdbba4e9c7a3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5cbc044d4ca7c5e7a12bcdbba4e9c7a3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5cbc044d4ca7c5e7a12bcdbba4e9c7a3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/5cbc044d4ca7c5e7a12bcdbba4e9c7a3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2021-04-15T08:10:25+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-15T08:10:25+02:00"
},
"updated_at": "2021-04-15T08:10:25+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-15T08:10:25+02:00",
"created_at": "2021-04-15T08:10:25+02:00",
"label_ids": [
],
"estimated_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_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/146/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 w-MOoT37MxhSGx5a9_633LtqhUjfcZ0V9B8ot8nrals" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/labels
POST /1.1/146/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer w-MOoT37MxhSGx5a9_633LtqhUjfcZ0V9B8ot8nrals
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/147/labels/2" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer iyMsS_KXPsSP6VaMkY0d69xyEjcdKmHH3DZi0dcziGQ" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/labels/:id
DELETE /1.1/147/labels/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer iyMsS_KXPsSP6VaMkY0d69xyEjcdKmHH3DZi0dcziGQ
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/150/labels?parent_id=4" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer htonWdJR6EKz9LiN16gBQUEtBEo2Dq8e8oiGHt6HRn8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/150/labels?parent_id=4
Accept: application/json
Content-Type: application/json
Authorization: Bearer htonWdJR6EKz9LiN16gBQUEtBEo2Dq8e8oiGHt6HRn8
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/149/labels" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer gpLefjuAVwgdgvYqTZ91eYTmj4UN9Srva4anPOQ5xSI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/149/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer gpLefjuAVwgdgvYqTZ91eYTmj4UN9Srva4anPOQ5xSI
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/148/labels/3" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer peYbXw6rWCauEP6FqZmiVWZgy_yaY4ErCOwhBIzoHDs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels/:id
GET /1.1/148/labels/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer peYbXw6rWCauEP6FqZmiVWZgy_yaY4ErCOwhBIzoHDs
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/151/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 _9mPZB7r1fFqSTJ7vElUu1TrOI6af41KFv9OYL0kKU4" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/labels/:id
PUT /1.1/151/labels/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer _9mPZB7r1fFqSTJ7vElUu1TrOI6af41KFv9OYL0kKU4
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/162/users/current/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer pcc4qpLxP7xpyMl76Qi8QUsOAs8cPB9CPv5Z-_p6Y-0" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current/permissions
GET /1.1/162/users/current/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer pcc4qpLxP7xpyMl76Qi8QUsOAs8cPB9CPv5Z-_p6Y-0
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/163/users/331/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer J-vVq5Q9zf2OMk5YZ52Y3JQ-p2jtUkJbDmHCK9DzUIs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/permissions
GET /1.1/163/users/331/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer J-vVq5Q9zf2OMk5YZ52Y3JQ-p2jtUkJbDmHCK9DzUIs
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/169/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":117,"budget_type":"M","budget":300,"users":[{"user_id":343}],"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 _SFxapPnX4zp46EG3GVvUbCANFYlhe6lU4_LcGnYemo" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects
POST /1.1/169/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer _SFxapPnX4zp46EG3GVvUbCANFYlhe6lU4_LcGnYemo
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":117,"budget_type":"M","budget":300,"users":[{"user_id":343}],"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": 98,
"active": true,
"account_id": 169,
"name": "New Project",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467050,
"external_id": null,
"budget_scope": null,
"client": {
"id": 117,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:50+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": 343,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2021-04-15T08:10:50+02:00",
"created_at": "2021-04-15T08:10:50+02:00",
"deleted": false
}
],
"labels": [
{
"project_id": 98,
"label_id": 6,
"budget": 0,
"required": true,
"updated_at": "2021-04-15T11:40:50+05:30"
},
{
"project_id": 98,
"label_id": 7,
"budget": 0,
"required": true,
"updated_at": "2021-04-15T11:40:50+05:30"
},
{
"project_id": 98,
"label_id": 8,
"budget": 0,
"required": false,
"updated_at": "2021-04-15T11:40:50+05:30"
},
{
"project_id": 98,
"label_id": 9,
"budget": 0,
"required": false,
"updated_at": "2021-04-15T11:40:50+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-15T08:10:50+02:00"
}
}
Delete a project
Request
curl "https://api.timelyapp.com/1.1/170/projects/99" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer vLHJjLnoCMROPBRhXdIOLZcGypwpsLNueryfUD0C8vM" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/projects/:id
DELETE /1.1/170/projects/99
Accept: application/json
Content-Type: application/json
Authorization: Bearer vLHJjLnoCMROPBRhXdIOLZcGypwpsLNueryfUD0C8vM
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/172/projects" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer q8lL8GJ6wM8Fv4oelULsWSb1miGyg71y6w8ATzAnBws" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects
GET /1.1/172/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer q8lL8GJ6wM8Fv4oelULsWSb1miGyg71y6w8ATzAnBws
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": 101,
"active": true,
"account_id": 172,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467052,
"external_id": null,
"budget_scope": null,
"client": {
"id": 120,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:52+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": 349,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2021-04-15T08:10:52+02:00",
"created_at": "2021-04-15T08:10:52+02:00",
"deleted": false
}
],
"labels": [
],
"label_ids": [
],
"required_label_ids": [
],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
}
}
]
Retrieve a project
Retrieve a single project by using its ID.
Request
curl -g "https://api.timelyapp.com/1.1/171/projects/100" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 25DReunEHD92GFy2NQtSwUddASt8KE8N-0aHbC5uoeA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:id
GET /1.1/171/projects/100
Accept: application/json
Content-Type: application/json
Authorization: Bearer 25DReunEHD92GFy2NQtSwUddASt8KE8N-0aHbC5uoeA
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": 100,
"active": true,
"account_id": 171,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467051,
"external_id": null,
"budget_scope": null,
"client": {
"id": 119,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:51+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": 347,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2021-04-15T08:10:51+02:00",
"created_at": "2021-04-15T08:10:51+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/174/projects/103" -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 xsZ7baiLMgJSXa-eq52pj2xYI4TQMwg-87SDdmviA0c" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:id
PUT /1.1/174/projects/103
Accept: application/json
Content-Type: application/json
Authorization: Bearer xsZ7baiLMgJSXa-eq52pj2xYI4TQMwg-87SDdmviA0c
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": 103,
"active": true,
"account_id": 174,
"name": "updated project name",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467053,
"external_id": null,
"budget_scope": null,
"client": {
"id": 122,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:10:53+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": 353,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2021-04-15T08:10:53+02:00",
"created_at": "2021-04-15T08:10:53+02:00",
"deleted": false
}
],
"labels": [
],
"label_ids": [
],
"required_label_ids": [
],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"first_logged_on": null,
"last_logged_on": null
}
Reports
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/208/reports" -d '{"user_ids":"454","since":"2018-01-01","until":"2019-01-01","project_ids":"174"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 4o34q8nGDBk6zxJFGHwhrEXseWZZ4XNxcwrSZ4gDnkM" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports
POST /1.1/208/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4o34q8nGDBk6zxJFGHwhrEXseWZZ4XNxcwrSZ4gDnkM
Parameters
{"user_ids":"454","since":"2018-01-01","until":"2019-01-01","project_ids":"174"}
| 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": 156,
"name": "Timely",
"projects": [
{
"id": 174,
"active": true,
"account_id": 208,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467074,
"external_id": null,
"budget_scope": null,
"client": {
"id": 156,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:11:14+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/209/reports/filter" -d '{"user_ids":"456","since":"2018-01-01","until":"2019-01-01","project_ids":"175"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ylZzQhqMUENC_N2D_Ll2YO-rXfx0XRh7A4xqJN8Kbrk" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports/filter
POST /1.1/209/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer ylZzQhqMUENC_N2D_Ll2YO-rXfx0XRh7A4xqJN8Kbrk
Parameters
{"user_ids":"456","since":"2018-01-01","until":"2019-01-01","project_ids":"175"}
| 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": 157,
"name": "Timely",
"projects": [
{
"id": 175,
"active": true,
"account_id": 209,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1618467075,
"external_id": null,
"budget_scope": null,
"client": {
"id": 157,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2021-04-15T08:11:15+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": 456,
"email": "marijalofassdg@timelyapp.com",
"name": "Marija Petrovic",
"time_zone": "Europe/Paris",
"updated_at": 1618467074,
"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/c2d7239d77d983551c473e286ebb23a6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/c2d7239d77d983551c473e286ebb23a6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/c2d7239d77d983551c473e286ebb23a6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/c2d7239d77d983551c473e286ebb23a6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/c2d7239d77d983551c473e286ebb23a6?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/210/roles" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer XmICg3pF6hi92Ri8Hf0gGTvJrGWGckjubzH2-tub0hA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/roles
GET /1.1/210/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer XmICg3pF6hi92Ri8Hf0gGTvJrGWGckjubzH2-tub0hA
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which roles are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 628,
"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": 630,
"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": 629,
"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/232/teams" -d '{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":502,"lead":true},{"user_id":504,"lead":false}]}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 1Wm_8Q90X9QwW1nyU73PI_VL-VhGuDPVvKmpY49YKSc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/teams
POST /1.1/232/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1Wm_8Q90X9QwW1nyU73PI_VL-VhGuDPVvKmpY49YKSc
Parameters
{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":502,"lead":true},{"user_id":504,"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": [
502,
504
],
"users": [
{
"id": 1,
"user_id": 502,
"team_id": 1,
"lead": true
},
{
"id": 2,
"user_id": 504,
"team_id": 1,
"lead": false
}
]
}
Delete a team
Request
curl "https://api.timelyapp.com/1.1/233/teams/2" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer zfeLhNGZZVpRI5Kt86FHxzr0aQwZ8sqIyisU0uw-Yfw" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/teams/:id
DELETE /1.1/233/teams/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer zfeLhNGZZVpRI5Kt86FHxzr0aQwZ8sqIyisU0uw-Yfw
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/235/teams" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer _PMqLs4n3gfIlXiufHtgaW8MZ9DtMTFMTNTSRYzxNrU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams
GET /1.1/235/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer _PMqLs4n3gfIlXiufHtgaW8MZ9DtMTFMTNTSRYzxNrU
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/234/teams/3" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer wRLz3PRqpR0uxIIes2kFeUQFlcy6ID1z7SeISDHorBA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams/:id
GET /1.1/234/teams/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer wRLz3PRqpR0uxIIes2kFeUQFlcy6ID1z7SeISDHorBA
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/236/teams/5" -d '{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":511,"lead":true}]}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer -jsGJXsE6lW5Md2WOTcF5oCBfFkl0e7hM0KKB8tLx7w" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/teams/:id
PUT /1.1/236/teams/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer -jsGJXsE6lW5Md2WOTcF5oCBfFkl0e7hM0KKB8tLx7w
Parameters
{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":511,"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": [
511
],
"users": [
{
"id": 3,
"user_id": 511,
"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/241/users/capacities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer pn3AJjN9z_MFrmKQi4Q2zTzf9u9-G1y2uFhd6LX_Upo" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/capacities
GET /1.1/241/users/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer pn3AJjN9z_MFrmKQi4Q2zTzf9u9-G1y2uFhd6LX_Upo
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": 521,
"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/240/users/519/capacities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer DzZ91mqf36ANiAdhvY0CArGXucaMztPfG9oFc_2xwC8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/capacities
GET /1.1/240/users/519/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer DzZ91mqf36ANiAdhvY0CArGXucaMztPfG9oFc_2xwC8
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/243/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":208,"hour_rate":10}]},"name":null,"admin":{"id":200,"email":"notifications@timelyapp.com","created_at":"2021-04-15T08:11:34.000+02:00","updated_at":"2021-04-15T08:11:34.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 tI14E33beVY3Mp-wHOCzK08y_ai-CVAEqm1LaLQo9AU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users
POST /1.1/243/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer tI14E33beVY3Mp-wHOCzK08y_ai-CVAEqm1LaLQo9AU
Parameters
{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":208,"hour_rate":10}]},"name":null,"admin":{"id":200,"email":"notifications@timelyapp.com","created_at":"2021-04-15T08:11:34.000+02:00","updated_at":"2021-04-15T08:11:34.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": 527,
"email": "marija@timely.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": false,
"memory_onboarded": false,
"created_at": 1618467094,
"updated_at": 1618467094,
"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": 728,
"role": {
"id": 728,
"name": "manager"
}
}
Delete a user
Request
curl "https://api.timelyapp.com/1.1/244/users/528" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer JoOzMxH6wFaRar5ntZT7DCHWQ5_RghcgZ-kaqe9J9XY" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/users/:id
DELETE /1.1/244/users/528
Accept: application/json
Content-Type: application/json
Authorization: Bearer JoOzMxH6wFaRar5ntZT7DCHWQ5_RghcgZ-kaqe9J9XY
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/247/users" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer _sTjlhD5ByD4zSjYh2uCBk5kvLtTDC7y44fZDfzn5BY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users
GET /1.1/247/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer _sTjlhD5ByD4zSjYh2uCBk5kvLtTDC7y44fZDfzn5BY
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": 534,
"email": "marijaoamcdwjv@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1618467096,
"updated_at": 1618467096,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/84e4606ed90b4b66bc73b746947d7ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/84e4606ed90b4b66bc73b746947d7ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/84e4606ed90b4b66bc73b746947d7ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/84e4606ed90b4b66bc73b746947d7ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/84e4606ed90b4b66bc73b746947d7ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/84e4606ed90b4b66bc73b746947d7ad6?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": 739,
"role": {
"id": 739,
"name": "admin"
}
}
]
Retrieve a user
Request
curl -g "https://api.timelyapp.com/1.1/245/users/530" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ogFi7rZ3E3NTWhU1IO6cGJCYpgTyGsgiQTGWSoD6S5E" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:id
GET /1.1/245/users/530
Accept: application/json
Content-Type: application/json
Authorization: Bearer ogFi7rZ3E3NTWhU1IO6cGJCYpgTyGsgiQTGWSoD6S5E
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": 530,
"email": "marijarpopihhi@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1618467095,
"updated_at": 1618467095,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/3c91499ff132c1c74a4054ae9b811bf8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/3c91499ff132c1c74a4054ae9b811bf8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/3c91499ff132c1c74a4054ae9b811bf8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3c91499ff132c1c74a4054ae9b811bf8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/3c91499ff132c1c74a4054ae9b811bf8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/3c91499ff132c1c74a4054ae9b811bf8?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": 733,
"role": {
"id": 733,
"name": "admin"
}
}
Retrieve current user
Request
curl -g "https://api.timelyapp.com/1.1/246/users/current" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 15vYxPgf8gIEOCEIoGbqQMwT4CuDVz0nM81rUKZRt9w" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current
GET /1.1/246/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer 15vYxPgf8gIEOCEIoGbqQMwT4CuDVz0nM81rUKZRt9w
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the current user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 532,
"email": "marijazjyafamo@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1618467095,
"updated_at": 1618467095,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/58282aee31acc05e8b5aba197ef08cfa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/58282aee31acc05e8b5aba197ef08cfa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/58282aee31acc05e8b5aba197ef08cfa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/58282aee31acc05e8b5aba197ef08cfa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/58282aee31acc05e8b5aba197ef08cfa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/58282aee31acc05e8b5aba197ef08cfa?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": 736,
"role": {
"id": 736,
"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/248/users/536" -d '{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":213,"hour_rate":10}]},"admin":{"id":205,"email":"notifications@timelyapp.com","created_at":"2021-04-15T08:11:37.000+02:00","updated_at":"2021-04-15T08:11:37.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 8IIWiVO2-mdImCITvHW1K3ss5mreg4afKZVFd52PzDo" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:id
PUT /1.1/248/users/536
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8IIWiVO2-mdImCITvHW1K3ss5mreg4afKZVFd52PzDo
Parameters
{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":213,"hour_rate":10}]},"admin":{"id":205,"email":"notifications@timelyapp.com","created_at":"2021-04-15T08:11:37.000+02:00","updated_at":"2021-04-15T08:11:37.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": 536,
"email": "marijafvjsbtwt@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1618467097,
"updated_at": 1618467097,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/3da386000d644ee09bb9d02780d61cca?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/3da386000d644ee09bb9d02780d61cca?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/3da386000d644ee09bb9d02780d61cca?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3da386000d644ee09bb9d02780d61cca?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/3da386000d644ee09bb9d02780d61cca?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/3da386000d644ee09bb9d02780d61cca?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": 743,
"role": {
"id": 743,
"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. |