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://app.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 "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 0UfGOcMzeOsnd4mytGo21pOgO0cbqhGdwr7hgVZUxmo" \
-H "Cookie: "
Endpoint
GET /1.1/accounts
GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0UfGOcMzeOsnd4mytGo21pOgO0cbqhGdwr7hgVZUxmo
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 630,
"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": 660,
"plan_name": "Essential",
"next_charge": "2025-03-07",
"start_of_week": 0,
"created_at": 1738929519,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 1628,
"weekly_user_capacity": 40.0,
"default_work_days": "MON,TUE,WED,THU,FRI",
"default_hour_rate": 0.0,
"support_email": "support@timelyapp.com",
"estimated_company_size": null,
"industry": null,
"memory_retention_days": 0,
"tic_force_enable": false,
"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,
"azure_ad_enabled": true,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "api_access",
"days": -1
},
{
"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": "people_dashboard",
"days": -1
},
{
"name": "people_notify",
"days": -1
},
{
"name": "premium_integrations",
"days": -1
},
{
"name": "individual_capacity",
"days": -1
},
{
"name": "audits",
"days": -1
},
{
"name": "project_dashboard",
"days": -1
},
{
"name": "high_level_reports",
"days": -1
},
{
"name": "live_reports",
"days": -1
},
{
"name": "invoices",
"days": -1
},
{
"name": "planned_entries",
"days": -1
},
{
"name": "internal_costs",
"days": -1
},
{
"name": "memory_retention",
"days": -1
},
{
"name": "custom_project_currencies",
"days": -1
},
{
"name": "capacity_reports",
"days": -1
},
{
"name": "day_locking",
"days": -1
},
{
"name": "user_custom_properties",
"days": -1
},
{
"name": "tasks",
"days": -1
},
{
"name": "planning",
"days": -1
},
{
"name": "batch_log_planned_time",
"days": -1
},
{
"name": "ai_labels_suggestions",
"days": -1
},
{
"name": "integration_monday",
"days": -1
},
{
"name": "hour_states",
"days": -1
},
{
"name": "tic_integrations",
"days": -1
},
{
"name": "tic_support",
"days": -1
},
{
"name": "csv_imports",
"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/628/activities" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer q1-__N23Nq37iVe2bZWFe6nYA8bKTe0s_LqmPKOcb_E" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/activities
GET /1.1/628/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer q1-__N23Nq37iVe2bZWFe6nYA8bKTe0s_LqmPKOcb_E
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": 83,
"user": {
"id": 1623,
"email": "marijatfwtmxvg@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:38+01:00"
},
"message": "archived",
"activity_type": "archive_project",
"url": "http://app.timelyapp.local:3002/628/projects/658?type=archived_project",
"updated_at": "2025-01-31T12:58:38+01:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 658,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 420,
"name": "Voluptas delectus voluptatem expedita.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:38+01:00"
},
"updated_at": "2025-02-07T12:58:38+01:00"
},
"anomaly": false
},
{
"id": 82,
"user": {
"id": 1623,
"email": "marijatfwtmxvg@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/78942225773a22198367c41cc3cc44e6?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:38+01:00"
},
"message": "50% of budget used",
"activity_type": "project_budget_progress_fifty",
"url": "http://app.timelyapp.local:3002/628/projects/658?type=budget_progress",
"updated_at": "2025-02-07T12:58:38+01:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 658,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 420,
"name": "Voluptas delectus voluptatem expedita.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:38+01:00"
},
"updated_at": "2025-02-07T12:58:38+01: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/629" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YyHJaSUig-w2J5mAUPjj5Mq_74HyAzknqw11yiCMeqY" \
-H "Cookie: "
Endpoint
GET /1.1/accounts/:id
GET /1.1/accounts/629
Accept: application/json
Content-Type: application/json
Authorization: Bearer YyHJaSUig-w2J5mAUPjj5Mq_74HyAzknqw11yiCMeqY
Parameters
| Name | Description |
|---|---|
| id | The id of the account to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 629,
"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": 659,
"plan_name": "Essential",
"next_charge": "2025-03-07",
"start_of_week": 0,
"created_at": 1738929519,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 1626,
"weekly_user_capacity": 40.0,
"default_work_days": "MON,TUE,WED,THU,FRI",
"default_hour_rate": 0.0,
"support_email": "support@timelyapp.com",
"estimated_company_size": null,
"industry": null,
"memory_retention_days": 0,
"tic_force_enable": false,
"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,
"azure_ad_enabled": true,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "api_access",
"days": -1
},
{
"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": "people_dashboard",
"days": -1
},
{
"name": "people_notify",
"days": -1
},
{
"name": "premium_integrations",
"days": -1
},
{
"name": "individual_capacity",
"days": -1
},
{
"name": "audits",
"days": -1
},
{
"name": "project_dashboard",
"days": -1
},
{
"name": "high_level_reports",
"days": -1
},
{
"name": "live_reports",
"days": -1
},
{
"name": "invoices",
"days": -1
},
{
"name": "planned_entries",
"days": -1
},
{
"name": "internal_costs",
"days": -1
},
{
"name": "memory_retention",
"days": -1
},
{
"name": "custom_project_currencies",
"days": -1
},
{
"name": "capacity_reports",
"days": -1
},
{
"name": "day_locking",
"days": -1
},
{
"name": "user_custom_properties",
"days": -1
},
{
"name": "tasks",
"days": -1
},
{
"name": "planning",
"days": -1
},
{
"name": "batch_log_planned_time",
"days": -1
},
{
"name": "ai_labels_suggestions",
"days": -1
},
{
"name": "integration_monday",
"days": -1
},
{
"name": "hour_states",
"days": -1
},
{
"name": "tic_integrations",
"days": -1
},
{
"name": "tic_support",
"days": -1
},
{
"name": "csv_imports",
"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/648/clients" -d '{"name":null,"client":{"name":"Uniq name","active":true,"external_id":null}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer w6R57HYPJi_aQ8sxCvbFcblahc2pI9zNdG30FVDKh4s" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/clients
POST /1.1/648/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer w6R57HYPJi_aQ8sxCvbFcblahc2pI9zNdG30FVDKh4s
Parameters
{"name":null,"client":{"name":"Uniq name","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": 436,
"name": "Uniq name",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:41+01:00"
}
List all clients
NOTE: By default, client list will return first 10000 clients in alphabetical order. You can also use optional parameters like “limit”, “offset”, “show” and “order” to change the results.
Request
curl -g "https://api.timelyapp.com/1.1/649/clients" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 5XZhium93Q-S2xGa4c8AW-XUgwt8zn157pv68gPDWRk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients
GET /1.1/649/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5XZhium93Q-S2xGa4c8AW-XUgwt8zn157pv68gPDWRk
Parameters
| Name | Description |
|---|---|
| account_id | Account ID for the clients you want to retrieve |
| limit | Retrieve number of clients |
| offset | Retrieve clients from offset |
| order | "asc (default)" and "desc" |
| 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": 437,
"name": "Saepe accusantium et veniam.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:42+01:00",
"external_references": []
}
]
Show client
Request
curl -g "https://api.timelyapp.com/1.1/651/clients/439" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer OfSS0XECR5LjitRyQQyvhWrJlQuhX6RH7ZTvwClqGXk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients/:id
GET /1.1/651/clients/439
Accept: application/json
Content-Type: application/json
Authorization: Bearer OfSS0XECR5LjitRyQQyvhWrJlQuhX6RH7ZTvwClqGXk
Parameters
| Name | Description |
|---|---|
| account_id | Account ID for the client you want to retrieve |
| id | Client ID to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 439,
"name": "Voluptatem consequatur saepe ratione.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:42+01:00",
"external_references": []
}
Update a client
Update client details just by using a client’s ID.
Request
curl "https://api.timelyapp.com/1.1/653/clients/441" -d '{"name":null,"client":{"name":"Updated name","active":true}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer keaAwkzhLijAfZshfEzSgQZSteg_C67U_3j31PPpeIg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/clients/:id
PUT /1.1/653/clients/441
Accept: application/json
Content-Type: application/json
Authorization: Bearer keaAwkzhLijAfZshfEzSgQZSteg_C67U_3j31PPpeIg
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": 441,
"name": "Updated name",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:42+01:00"
}
Day locking (Locked Time)
Locked Time helps prevent accidental changes or unauthorized edits, making your time records more trustworthy and dependable. This feature offers you a peace of mind by allowing control over which days, weeks, or months to lock or unlock.
Create a Day locking
This API allow you to lock days for an user.
Request
curl "https://api.timelyapp.com/1.1/654/day_properties" -d '{"day_property":{"user_ids":[1681],"dates":["2025-02-07","2025-02-08"],"locked":true}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer dagvo0qNmpEJjYwN35OpXIKWse0f3kPrTkHerT-mDAM" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/day_properties
POST /1.1/654/day_properties
Accept: application/json
Content-Type: application/json
Authorization: Bearer dagvo0qNmpEJjYwN35OpXIKWse0f3kPrTkHerT-mDAM
Parameters
{"day_property":{"user_ids":[1681],"dates":["2025-02-07","2025-02-08"],"locked":true}}
| Name | Description |
|---|---|
| user_ids required | Specifies the users for which you want lock days. Numerical user IDs should separated by a comma, like so: "user_ids": "175551,117861" |
| dates required | Specifies the dates to lock, should separated by a comma. Example: dates="2024-08-24, 2024-08-23" |
| locked | Example values: "true" or "false". Using "false" unlocks the days" |
Response
Content-Type: application/json; charset=utf-8
201 Created
[
{
"id": 11,
"user_id": 1681,
"account_id": 654,
"date": "2025-02-07",
"locked": true,
"updated_at": 1738929523,
"created_at": 1738929523
},
{
"id": 12,
"user_id": 1681,
"account_id": 654,
"date": "2025-02-08",
"locked": true,
"updated_at": 1738929523,
"created_at": 1738929523
}
]
List all locked dates
Note: 1. If “since” and “until” parameters are not passed, the period will default to the current week.
2. If the “user_ids” parameters is not passed, the default will be current user's manageable users.
Request
curl -g "https://api.timelyapp.com/1.1/655/day_properties" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer uwAam0Ii0BgWp8KDya7PO50Sw2DeNWlTOvjV51oShM4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/day_properties
GET /1.1/655/day_properties
Accept: application/json
Content-Type: application/json
Authorization: Bearer uwAam0Ii0BgWp8KDya7PO50Sw2DeNWlTOvjV51oShM4
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the locked dates you want to retrieve |
| since | Specifies the start date for returned results. Example: since=2014-08-18 |
| until | Specifies the end date for returned results. Example: upto=2014-08-24 |
| dates | Specifies the dates for returned results, should separated by a comma. Example: dates="2024-08-24, 2024-08-23" |
| user_ids | Specifies the users for which you want results. Numerical user IDs should separated by a comma, like so: "user_ids": "175551,117861" |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 13,
"user_id": 1683,
"account_id": 655,
"date": "2025-02-07",
"locked": true,
"updated_at": 1738929523,
"created_at": 1738929523
},
{
"id": 14,
"user_id": 1683,
"account_id": 655,
"date": "2025-02-08",
"locked": true,
"updated_at": 1738929523,
"created_at": 1738929523
}
]
Update Day locking
Update locked time by user_ids OR dates.
Request
curl "https://api.timelyapp.com/1.1/656/day_properties" -d '{"day_property":{"user_ids":[1685],"dates":["2025-02-07","2025-02-08"],"locked":false}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer N9z5MfJImHCEawiqugqcxibCWjS4ztRGRb3ANsgXfHk" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/day_properties
PUT /1.1/656/day_properties
Accept: application/json
Content-Type: application/json
Authorization: Bearer N9z5MfJImHCEawiqugqcxibCWjS4ztRGRb3ANsgXfHk
Parameters
{"day_property":{"user_ids":[1685],"dates":["2025-02-07","2025-02-08"],"locked":false}}
| Name | Description |
|---|---|
| user_ids required | Specifies the users for which you want lock days. Numerical user IDs should separated by a comma, like so: "user_ids": "175551,117861" |
| dates required | Specifies the dates to lock, should separated by a comma. Example: dates="2024-08-24, 2024-08-23" |
| locked | Example values: "true" or "false". Using "false" unlocks the days" |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 15,
"user_id": 1685,
"account_id": 656,
"date": "2025-02-07",
"locked": false,
"updated_at": 1738929523,
"created_at": 1738929523
},
{
"id": 16,
"user_id": 1685,
"account_id": 656,
"date": "2025-02-08",
"locked": false,
"updated_at": 1738929523,
"created_at": 1738929523
}
]
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/675/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:45.362Z","to":"2025-02-07T15:28:45.362Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":688}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer gjB9-tgZt-ruvaMDhiXaXmTM-LebWpJE0moY6DSJ19c" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/events
POST /1.1/675/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer gjB9-tgZt-ruvaMDhiXaXmTM-LebWpJE0moY6DSJ19c
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:45.362Z","to":"2025-02-07T15:28:45.362Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":688}}
| Name | Description |
|---|---|
| user_id | The numerical ID for the user who the event is created for. Note: the default value is the user_id connected to the API token. Example value: 123 |
| 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": 894,
"uid": "4b0250793549726d5c1ea3906726ebfe",
"user": {
"id": 1723,
"email": "marijazqcertsi@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/697b9049566a8e83afcddbe30a3fe2de?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/697b9049566a8e83afcddbe30a3fe2de?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/697b9049566a8e83afcddbe30a3fe2de?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/697b9049566a8e83afcddbe30a3fe2de?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/697b9049566a8e83afcddbe30a3fe2de?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:45+01:00"
},
"project": {
"id": 688,
"active": true,
"account_id": 675,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929525,
"updated_at": 1738929525,
"external_id": null,
"budget_scope": null,
"client": {
"id": 451,
"name": "Corporis enim occaecati alias.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:45+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929525,
"created_at": 1738929525,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:45+01:00",
"from": "2025-02-07T12:58:45+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 1723,
"updater_id": 1723,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
Create an event for a project
Request
curl "https://api.timelyapp.com/1.1/674/projects/687/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:45.168Z","to":"2025-02-07T15:28:45.168Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":687}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ptf4wEMMQKWpb6rsNdnIb5lvKzf3-2zUwS8NrWJRKoE" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects/:project_id/events
POST /1.1/674/projects/687/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ptf4wEMMQKWpb6rsNdnIb5lvKzf3-2zUwS8NrWJRKoE
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:45.168Z","to":"2025-02-07T15:28:45.168Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":687}}
| Name | Description |
|---|---|
| user_id | The numerical ID for the user who the event is created for. Note: the default value is the user_id connected to the API token. Example value: 123 |
| 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": 893,
"uid": "d56b9fc4b0f1be8871f5e1c40c0067e7",
"user": {
"id": 1721,
"email": "marijazqfoxllx@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/fcf18707916444f76a5ed720971e46c3?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/fcf18707916444f76a5ed720971e46c3?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/fcf18707916444f76a5ed720971e46c3?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/fcf18707916444f76a5ed720971e46c3?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/fcf18707916444f76a5ed720971e46c3?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:44+01:00"
},
"project": {
"id": 687,
"active": true,
"account_id": 674,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929525,
"updated_at": 1738929525,
"external_id": null,
"budget_scope": null,
"client": {
"id": 450,
"name": "Omnis consequatur ullam velit.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:45+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929525,
"created_at": 1738929525,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:45+01:00",
"from": "2025-02-07T12:58:45+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 1721,
"updater_id": 1721,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
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/673/users/1719/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:44.912Z","to":"2025-02-07T15:28:44.912Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":1719}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eHEH08NuCob7XiFt34AMsR-HzlCyAVo7p1gMJgBkk9I" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users/:user_id/events
POST /1.1/673/users/1719/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer eHEH08NuCob7XiFt34AMsR-HzlCyAVo7p1gMJgBkk9I
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:44.912Z","to":"2025-02-07T15:28:44.912Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":1719}}
| Name | Description |
|---|---|
| user_id required | The numerical ID for the user who the event is created for. Note: the default value is the user_id connected to the API token. Example value: 123 |
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 892,
"uid": "c2aee86157b4a40b78132f1e71a9e6f1",
"user": {
"id": 1719,
"email": "marijaevzdfdzg@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/89066143a067d7383efbde0a63f76570?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/89066143a067d7383efbde0a63f76570?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/89066143a067d7383efbde0a63f76570?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/89066143a067d7383efbde0a63f76570?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/89066143a067d7383efbde0a63f76570?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:44+01:00"
},
"project": {
"id": 686,
"active": true,
"account_id": 673,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929524,
"updated_at": 1738929524,
"external_id": null,
"budget_scope": null,
"client": {
"id": 449,
"name": "Laborum ut sed adipisci.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:44+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929524,
"created_at": 1738929524,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:44+01:00",
"from": "2025-02-07T12:58:44+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 1719,
"updater_id": 1719,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
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/672/bulk/events" -d '{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:44.644Z","to":"2025-02-07T15:28:44.644Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":1717,"account_id":672,"project_id":685}]}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer BghZMqhpyZ4ttYHvvimq2GV5nticAoI2bwbQ5M7Yq8Y" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/672/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer BghZMqhpyZ4ttYHvvimq2GV5nticAoI2bwbQ5M7Yq8Y
Parameters
{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2025-02-07T11:58:44.644Z","to":"2025-02-07T15:28:44.644Z","day":"2025-02-07","note":"Notes for testing with some random #hash in it.","hour_rate":100,"internal_hour_rate":150,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":1717,"account_id":672,"project_id":685}]}
| 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": [
891
],
"updated_ids": [],
"errors": {
"create": [],
"update": [],
"delete": []
},
"job": null
}
Delete an event
Note: Normal users can delete events logged to other projects by other users on an account. Limited users can only delete their own events.
Request
curl "https://api.timelyapp.com/1.1/677/events/896" -d '' -X DELETE \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TIXl-POH3Fdbc9djFrIEMcBVzOGbkf7EVQH4q6GnXuI" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/events/:id
DELETE /1.1/677/events/896
Accept: application/json
Content-Type: application/json
Authorization: Bearer TIXl-POH3Fdbc9djFrIEMcBVzOGbkf7EVQH4q6GnXuI
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/676/bulk/events" -d '{"delete":[895]}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer MPHdRxPvfQpe1NskTuGj1IQerW68l9GBduFAGsYwdgc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/676/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer MPHdRxPvfQpe1NskTuGj1IQerW68l9GBduFAGsYwdgc
Parameters
{"delete":[895]}
| 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": [
895
],
"created_ids": [],
"updated_ids": [],
"errors": {
"create": [],
"update": [],
"delete": []
},
"job": null
}
List all events
Get all events linked to active projects on a user’s account.
Note: If “since” and “upto” parameters are not passed, the period will default to the date of access.
Request
curl -g "https://api.timelyapp.com/1.1/682/events" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6Iw_YckGt1LDr5T5X9fpyvB_cMiq1uO0VToCjfJMCs4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events
GET /1.1/682/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6Iw_YckGt1LDr5T5X9fpyvB_cMiq1uO0VToCjfJMCs4
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the hours you want to retrieve |
| day | Specifies the day date for returned results. Example: day=2014-08-24 |
| 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 |
| filter | Specifies which records to retrieve (Default logged). Example: filter=logged or filter=all |
| sort | Field to sort projects by (Default updated_at) |
| order | Order to retrieve records (Default updated_at DESC) |
| per_page | Records per page (Default 100) |
| page | Page number (Default 1) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 901,
"uid": "892c91e0a653ba19df81a90f89d99bcd",
"user": {
"id": 1737,
"email": "marijaymqixsmj@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/46f50498fccbd5b9062306d2be1d7fbc?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/46f50498fccbd5b9062306d2be1d7fbc?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/46f50498fccbd5b9062306d2be1d7fbc?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/46f50498fccbd5b9062306d2be1d7fbc?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/46f50498fccbd5b9062306d2be1d7fbc?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:46+01:00"
},
"project": {
"id": 695,
"active": true,
"account_id": 682,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929526,
"updated_at": 1738929526,
"external_id": null,
"budget_scope": null,
"client": {
"id": 458,
"name": "Optio qui amet debitis.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:46+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929526,
"created_at": 1738929526,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:46+01:00",
"from": "2025-02-07T12:58:46+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
]
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/685/projects/698/events" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer j9sGS4Hubq028rELQyhMZEm0rrmlPheusucP5O3iE-Y" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:project_id/events
GET /1.1/685/projects/698/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer j9sGS4Hubq028rELQyhMZEm0rrmlPheusucP5O3iE-Y
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 |
| sort | Field to sort projects by (Default updated_at) |
| order | Order to retrieve records (Default updated_at DESC) |
| per_page | Records per page (Default 100) |
| page | Page number (Default 1) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 904,
"uid": "f47d0ad31c4c49061b9e505593e3db98",
"user": {
"id": 1743,
"email": "marijaufofilrt@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/5478e02e80afbfa881be42fb54ea7f54?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/5478e02e80afbfa881be42fb54ea7f54?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5478e02e80afbfa881be42fb54ea7f54?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5478e02e80afbfa881be42fb54ea7f54?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/5478e02e80afbfa881be42fb54ea7f54?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:47+01:00"
},
"project": {
"id": 698,
"active": true,
"account_id": 685,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929527,
"updated_at": 1738929527,
"external_id": null,
"budget_scope": null,
"client": {
"id": 461,
"name": "Non iure et soluta.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:47+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929527,
"created_at": 1738929527,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:47+01:00",
"from": "2025-02-07T12:58:47+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
]
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/684/users/1741/events" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer W24dZLBtQDrjfi9NIBwzUxIdavZR6pH_wf1DpFuN5k4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/events
GET /1.1/684/users/1741/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer W24dZLBtQDrjfi9NIBwzUxIdavZR6pH_wf1DpFuN5k4
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 |
| sort | Field to sort projects by (Default updated_at) |
| order | Order to retrieve records (Default updated_at DESC) |
| per_page | Records per page (Default 100) |
| page | Page number (Default 1) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 903,
"uid": "aa169b49b583a2b5af89203c2b78c67c",
"user": {
"id": 1741,
"email": "marijazhnnstqc@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/273f795dc0dd55239ba8d04785bc6723?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/273f795dc0dd55239ba8d04785bc6723?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/273f795dc0dd55239ba8d04785bc6723?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/273f795dc0dd55239ba8d04785bc6723?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/273f795dc0dd55239ba8d04785bc6723?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:46+01:00"
},
"project": {
"id": 697,
"active": true,
"account_id": 684,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929526,
"updated_at": 1738929526,
"external_id": null,
"budget_scope": null,
"client": {
"id": 460,
"name": "Pariatur tempore est ullam.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:46+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929526,
"created_at": 1738929526,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:46+01:00",
"from": "2025-02-07T12:58:46+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
]
Logged in user updating details and user of an event
Request
curl "https://api.timelyapp.com/1.1/693/users/1759/events/912" -d '{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer vK3s9wH7Q3o5KRazYbMeVP5rNZ5RE3bmeQFWUw8itNA" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:user_id/events/:id
PUT /1.1/693/users/1759/events/912
Accept: application/json
Content-Type: application/json
Authorization: Bearer vK3s9wH7Q3o5KRazYbMeVP5rNZ5RE3bmeQFWUw8itNA
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": 912,
"uid": "2a9d121cd9c3a1832bb6d2cc6bd7a8a7",
"user": {
"id": 1759,
"email": "marijaayhcsmai@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/5c750228d89a2d2aa26e1a6d31b4bf02?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/5c750228d89a2d2aa26e1a6d31b4bf02?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5c750228d89a2d2aa26e1a6d31b4bf02?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5c750228d89a2d2aa26e1a6d31b4bf02?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/5c750228d89a2d2aa26e1a6d31b4bf02?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:48+01:00"
},
"project": {
"id": 706,
"active": true,
"account_id": 693,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929528,
"updated_at": 1738929528,
"external_id": null,
"budget_scope": null,
"client": {
"id": 469,
"name": "Quod perspiciatis sed quas.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:48+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929528,
"created_at": 1738929528,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:48+01:00",
"from": "2025-02-07T12:58:48+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 1759,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
Loggedin user updating details and project of their event
Request
curl "https://api.timelyapp.com/1.1/692/projects/705/events/911" -d '{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer UGxM0Epnh3QEVoEsRAMisBDsA7uKpZ56Xfl96xF4LVU" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:project_id/events/:id
PUT /1.1/692/projects/705/events/911
Accept: application/json
Content-Type: application/json
Authorization: Bearer UGxM0Epnh3QEVoEsRAMisBDsA7uKpZ56Xfl96xF4LVU
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": 911,
"uid": "b56a18e0eacdf51aa2a5306b0f533204",
"user": {
"id": 1757,
"email": "marijagixdlgqu@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/60d0f537664156688bf254da43a549a7?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/60d0f537664156688bf254da43a549a7?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/60d0f537664156688bf254da43a549a7?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/60d0f537664156688bf254da43a549a7?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/60d0f537664156688bf254da43a549a7?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:48+01:00"
},
"project": {
"id": 705,
"active": true,
"account_id": 692,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929528,
"updated_at": 1738929528,
"external_id": null,
"budget_scope": null,
"client": {
"id": 468,
"name": "Pariatur quisquam ad corrupti.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:48+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929528,
"created_at": 1738929528,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:48+01:00",
"from": "2025-02-07T12:58:48+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 1757,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
Retrieve an event
Request
curl -g "https://api.timelyapp.com/1.1/680/events/899" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jDk5UBz9X6a7G2rc8dduPuio_Kw48Wz0vgJEqj5LJsw" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events/:id
GET /1.1/680/events/899
Accept: application/json
Content-Type: application/json
Authorization: Bearer jDk5UBz9X6a7G2rc8dduPuio_Kw48Wz0vgJEqj5LJsw
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": 899,
"uid": "01882513d5fa7c329e940dda99b12147",
"user": {
"id": 1733,
"email": "marijaajuzvcxi@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/5612469c29c9fa0db15aeb09d3805504?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/5612469c29c9fa0db15aeb09d3805504?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5612469c29c9fa0db15aeb09d3805504?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5612469c29c9fa0db15aeb09d3805504?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/5612469c29c9fa0db15aeb09d3805504?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:46+01:00"
},
"project": {
"id": 693,
"active": true,
"account_id": 680,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929526,
"updated_at": 1738929526,
"external_id": null,
"budget_scope": null,
"client": {
"id": 456,
"name": "Molestiae excepturi a blanditiis.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:46+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"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": 1738929526,
"created_at": 1738929526,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:46+01:00",
"from": "2025-02-07T12:58:46+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
Start timer on an event
Request
curl "https://api.timelyapp.com/1.1/686/events/905/start" -d '' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ssTppg5je-vqubcXDI_WzPJyDd6gVpVLsFD-kLA1440" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/start
PUT /1.1/686/events/905/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer ssTppg5je-vqubcXDI_WzPJyDd6gVpVLsFD-kLA1440
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 905,
"uid": "f57a2f557b098c43f11ab969efe1504b",
"user": {
"id": 1745,
"email": "marijaftmpubzl@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/37a02ed0d0675c2e22340be669c60172?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/37a02ed0d0675c2e22340be669c60172?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/37a02ed0d0675c2e22340be669c60172?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/37a02ed0d0675c2e22340be669c60172?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/37a02ed0d0675c2e22340be669c60172?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:47+01:00"
},
"project": {
"id": 699,
"active": true,
"account_id": 686,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929527,
"updated_at": 1738929527,
"external_id": null,
"budget_scope": null,
"client": {
"id": 462,
"name": "Numquam ea voluptatem repellat.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:47+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 35000,
"formatted": "$350.00",
"amount": 350.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "start",
"timer_started_on": 1738929527,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1738929527,
"created_at": 1738929527,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:47+01:00",
"from": "2025-02-07T12:58:47+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 1745,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [
{
"id": 23,
"hour_id": 905,
"from": "2025-02-07T09:28:47+01:00",
"to": "2025-02-07T12:58:47+01:00",
"entry_ids": []
}
],
"state": null,
"external_links": []
}
Stop timer on an event
Request
curl "https://api.timelyapp.com/1.1/687/events/906/stop" -d '' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer iwLyixjfxT5_vjS2fcHnisr0hMQdDvbENmRm2tAZ_y8" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/stop
PUT /1.1/687/events/906/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer iwLyixjfxT5_vjS2fcHnisr0hMQdDvbENmRm2tAZ_y8
Parameters
| Name | Description |
|---|---|
| id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 906,
"uid": "c8fbbc86abe8bd6a5eb6a3b4d0411301",
"user": {
"id": 1747,
"email": "marijayldwfdpj@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/4a59aa74294a81973fbb572f0002c007?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/4a59aa74294a81973fbb572f0002c007?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/4a59aa74294a81973fbb572f0002c007?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/4a59aa74294a81973fbb572f0002c007?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/4a59aa74294a81973fbb572f0002c007?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:47+01:00"
},
"project": {
"id": 700,
"active": true,
"account_id": 687,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929527,
"updated_at": 1738929527,
"external_id": null,
"budget_scope": null,
"client": {
"id": 463,
"name": "Enim id consequatur nihil.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:47+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"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": 45000,
"formatted": "$450.00",
"amount": 450.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "stop",
"timer_started_on": 0,
"timer_stopped_on": 1738929527,
"label_ids": [],
"user_ids": [],
"updated_at": 1738929527,
"created_at": 1738929527,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:47+01:00",
"from": "2025-02-07T12:58:47+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 1747,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
Update an event
Request
curl "https://api.timelyapp.com/1.1/691/events/910" -d '{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 3pgX-RXQrTmDExaewwSPbV0qvuRBWvM8FLu8xoZK41s" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id
PUT /1.1/691/events/910
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3pgX-RXQrTmDExaewwSPbV0qvuRBWvM8FLu8xoZK41s
Parameters
{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
| Name | Description |
|---|---|
| user_id | The numerical ID for the user who the event is updated for. Note: the default value is the user_id connected to the API token. Example value: 123 |
| id required | Event ID |
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| project_id | Project ID |
| estimated_minutes | Specifies estimated minutes for an event. Example values: 0-60 |
| estimated_hours | Specifies estimated hours for an event. Example values: 0-12 |
| note | Specifies notes for an event |
| from | Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies label IDs for an event. Example values: label_ids:[2,3,4] |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
| billed | Specifies whether you want an event to be marked as billed. For example: 'billed': false or 'billed': true |
| billable | Specifies whether you want an event to be billable or non-billable. For example: 'billable': false or 'billable': true |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 910,
"uid": "e205ee2a5de471a70c1fd1b46033a75f",
"user": {
"id": 1755,
"email": "marijaalxsvkxr@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/b2aec40b11119b0e6c8eedf06f6f2551?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/b2aec40b11119b0e6c8eedf06f6f2551?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/b2aec40b11119b0e6c8eedf06f6f2551?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/b2aec40b11119b0e6c8eedf06f6f2551?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/b2aec40b11119b0e6c8eedf06f6f2551?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:48+01:00"
},
"project": {
"id": 704,
"active": true,
"account_id": 691,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929528,
"updated_at": 1738929528,
"external_id": null,
"budget_scope": null,
"client": {
"id": 467,
"name": "Ab voluptas libero eum.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:48+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": [],
"default_label_ids": [],
"created_from": "Web"
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0,
"currency_code": "usd"
},
"day": "2025-02-07",
"note": "Updated notes",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1738929528,
"created_at": 1738929528,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2025-02-07T16:28:48+01:00",
"from": "2025-02-07T12:58:48+01:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 1755,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"external_link_ids": [],
"internal_cost": {},
"estimated_internal_cost": {},
"internal_cost_rate": 0,
"profit": 0,
"profitability": 0,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
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/688/bulk/events" -d '{"update":[{"id":907,"note":"updated","billed":true}]}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 4DAYxBuNEcOyeUiCRvDmzJOiyoefFbMBKIK1Avjd_hk" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/688/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4DAYxBuNEcOyeUiCRvDmzJOiyoefFbMBKIK1Avjd_hk
Parameters
{"update":[{"id":907,"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": [
907
],
"errors": {
"create": [],
"update": [],
"delete": []
},
"job": null
}
Forecasts (Tasks)
Forecasts (Tasks) 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/725/forecasts" -d '{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":150,"users":[{"id":1822}],"project_id":721,"title":"Title"}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 8pyStTjoN0B35lUtuTczyMicn4FoA9qXP6Qf83jyDmM" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/forecasts
POST /1.1/725/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8pyStTjoN0B35lUtuTczyMicn4FoA9qXP6Qf83jyDmM
Parameters
{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":150,"users":[{"id":1822}],"project_id":721,"title":"Title"}}
| Name | Description |
|---|---|
| estimated_minutes | Forecast minutes |
| title | Specifies title for a forecast |
| from | Specifies the “from” time in a timestamp. Example values: from: "2022-05-26T10:00:00+05:30" |
| to | Specifies the “to” time in a timestamp. Example values: to: "2022-05-26T12:00:00+05:30" |
| users | Forecast assignees. Example values: [{ id: 1 }, { id: 3 }] |
| 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] |
| 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": 69,
"note": "Title",
"title": "Title",
"description": "",
"from": "2022-05-10",
"to": "2022-05-16",
"user": {
"id": 1822,
"email": "marijannwshbom@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:50+01:00",
"estimated_minutes": 150,
"estimated_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"weekly_capacity": 40.0,
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR"
},
"users": [
{
"id": 1822,
"email": "marijannwshbom@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/f11fd3f2a6b48ce18b43b1fa9a75e779?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:50+01:00",
"estimated_minutes": 0,
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"weekly_capacity": 40.0,
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR"
}
],
"project": {
"id": 721,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 492,
"name": "Aspernatur mollitia blanditiis quia.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:50+01:00"
},
"updated_at": "2025-02-07T12:58:50+01:00"
},
"estimated_minutes": 150,
"updated_at": "2025-02-07T12:58:50+01:00",
"created_at": "2025-02-07T12:58:50+01:00",
"label_ids": [],
"estimated_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"planned_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"logged_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"completed": false,
"completed_at": null,
"manage": true,
"external_id": null
}
Delete a forecast
Request
curl "https://api.timelyapp.com/1.1/726/forecasts/70" -d '' -X DELETE \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer JBqynfW6vZaWf8ZSVCMGM_MgqOS3tpVX_94f8M-peYg" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/forecasts/:id
DELETE /1.1/726/forecasts/70
Accept: application/json
Content-Type: application/json
Authorization: Bearer JBqynfW6vZaWf8ZSVCMGM_MgqOS3tpVX_94f8M-peYg
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/727/forecasts" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer NsMAl9D4OqQtLUpJrspMPPffz0fc71lydS9L10EjrF4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/forecasts
GET /1.1/727/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer NsMAl9D4OqQtLUpJrspMPPffz0fc71lydS9L10EjrF4
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing 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: "forecast_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": 71,
"note": "title",
"title": "title",
"description": null,
"from": "2025-02-03",
"to": "2025-02-09",
"user": {
"id": 1829,
"email": "quentinjbpiaszv@timelyapp.com",
"name": "Quintin Duponde",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/5671db5535bec3d09af15b2e76e07177?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/5671db5535bec3d09af15b2e76e07177?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5671db5535bec3d09af15b2e76e07177?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5671db5535bec3d09af15b2e76e07177?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/5671db5535bec3d09af15b2e76e07177?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:50+01:00",
"estimated_minutes": 360,
"estimated_duration": {
"hours": 6,
"minutes": 0,
"seconds": 0,
"formatted": "06:00",
"total_hours": 6.0,
"total_seconds": 21600,
"total_minutes": 360
},
"weekly_capacity": 40.0,
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR"
},
"users": [
{
"id": 1827,
"email": "marijaaeismcqg@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/2b264ba7536a857742f54a895e4c7455?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/2b264ba7536a857742f54a895e4c7455?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/2b264ba7536a857742f54a895e4c7455?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/2b264ba7536a857742f54a895e4c7455?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/2b264ba7536a857742f54a895e4c7455?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:50+01:00",
"estimated_minutes": 0,
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"weekly_capacity": 40.0,
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR"
}
],
"project": {
"id": 723,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 494,
"name": "Sed asperiores molestiae omnis.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:50+01:00"
},
"updated_at": "2025-02-07T12:58:50+01:00"
},
"estimated_minutes": 360,
"updated_at": "2025-02-07T12:58:50+01:00",
"created_at": "2025-02-07T12:58:50+01:00",
"label_ids": [],
"estimated_duration": {
"hours": 6,
"minutes": 0,
"seconds": 0,
"formatted": "06:00",
"total_hours": 6.0,
"total_seconds": 21600,
"total_minutes": 360
},
"planned_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"logged_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"completed": false,
"completed_at": null,
"manage": true,
"external_id": null
}
]
Update a forecast
Request
curl "https://api.timelyapp.com/1.1/728/forecasts/72" -d '{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":30,"users":[{"id":1830}],"project_id":724,"title":"new title"}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer I5k6-BgCglfq2t0RgAT8nPEipEi5wNfqfGz6YSFzm_E" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/forecasts/:id
PUT /1.1/728/forecasts/72
Accept: application/json
Content-Type: application/json
Authorization: Bearer I5k6-BgCglfq2t0RgAT8nPEipEi5wNfqfGz6YSFzm_E
Parameters
{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":30,"users":[{"id":1830}],"project_id":724,"title":"new title"}}
| Name | Description |
|---|---|
| id required | Forecast ID |
| estimated_minutes required | Forecast minutes |
| title | Specifies title for a forecast |
| from | Specifies the “from” time in a timestamp. Example values: from: "2022-05-26T10:00:00+05:30" |
| to | Specifies the “to” time in a timestamp. Example values: to: "2022-05-26T12:00:00+05:30" |
| users | Forecast assignees. Example values: [{ id: 1 }, { id: 3 }] |
| 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] |
| 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": 72,
"note": "new title",
"title": "new title",
"description": "",
"from": "2022-05-10",
"to": "2022-05-16",
"user": {
"id": 1830,
"email": "marijabhorksun@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:51+01:00",
"estimated_minutes": 30,
"estimated_duration": {
"hours": 0,
"minutes": 30,
"seconds": 0,
"formatted": "00:30",
"total_hours": 0.5,
"total_seconds": 1800,
"total_minutes": 30
},
"weekly_capacity": 40.0,
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR"
},
"users": [
{
"id": 1830,
"email": "marijabhorksun@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/8f2d1a8cfb3324f8efed01525f6f552f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2025-02-07T12:58:51+01:00",
"estimated_minutes": 0,
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"weekly_capacity": 40.0,
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR"
}
],
"project": {
"id": 724,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 495,
"name": "Facere ut tempore alias.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:51+01:00"
},
"updated_at": "2025-02-07T12:58:51+01:00"
},
"estimated_minutes": 30,
"updated_at": "2025-02-07T12:58:51+01:00",
"created_at": "2025-02-07T12:58:51+01:00",
"label_ids": [],
"estimated_duration": {
"hours": 0,
"minutes": 30,
"seconds": 0,
"formatted": "00:30",
"total_hours": 0.5,
"total_seconds": 1800,
"total_minutes": 30
},
"planned_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"logged_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"completed": false,
"completed_at": null,
"manage": true,
"external_id": null
}
Labels
Labels (AKA Tags) help you classify work, group related tasks and require certain information for events. This API lets you to create, list, update and delete tags created on an account.
Create a label
Request
curl "https://api.timelyapp.com/1.1/766/labels" -d '{"name":null,"label":{"name":"Web Programming","active":true}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Be1Y1pp4k7v-sPjmidNtCCin8gPrKvQdY9NY4da-nuA" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/labels
POST /1.1/766/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer Be1Y1pp4k7v-sPjmidNtCCin8gPrKvQdY9NY4da-nuA
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": 172,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7-fe0f.png",
"active": true,
"created_at": "2025-02-07T12:58:54+01:00",
"updated_at": "2025-02-07T12:58:54+01:00",
"children": []
}
Delete a label
Request
curl "https://api.timelyapp.com/1.1/767/labels/173" -d '' -X DELETE \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer gu5XVShX76DaxlvvlhYwZcMbBHtqBeEaq1CeAXWXfgk" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/labels/:id
DELETE /1.1/767/labels/173
Accept: application/json
Content-Type: application/json
Authorization: Bearer gu5XVShX76DaxlvvlhYwZcMbBHtqBeEaq1CeAXWXfgk
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/770/labels?parent_id=175" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6mR1OH1jKNb2RyD-IMQhDeuuz982LPNTSuBMQsMUeJk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/770/labels?parent_id=175
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6mR1OH1jKNb2RyD-IMQhDeuuz982LPNTSuBMQsMUeJk
Parameters
parent_id: 175
| 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": 175,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"active": true,
"created_at": "2025-02-07T12:58:54+01:00",
"updated_at": "2025-02-07T12:58:54+01:00",
"children": []
}
List all labels
Get all the tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/769/labels" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer d7fxjebkUaNg7HB1tpC09v0rsdJo_peY4d6U3GFlK_U" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/769/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer d7fxjebkUaNg7HB1tpC09v0rsdJo_peY4d6U3GFlK_U
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/768/labels/174" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer R1tWZ9Qdxw-Bo_n59CLEscFexWm0Ut8EKzGUdiI4UJY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels/:id
GET /1.1/768/labels/174
Accept: application/json
Content-Type: application/json
Authorization: Bearer R1tWZ9Qdxw-Bo_n59CLEscFexWm0Ut8EKzGUdiI4UJY
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": 174,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"active": true,
"created_at": "2025-02-07T12:58:54+01:00",
"updated_at": "2025-02-07T12:58:54+01:00",
"children": []
}
Update a label
Request
curl "https://api.timelyapp.com/1.1/771/labels/176" -d '{"name":null,"label":{"name":"updated name"}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer nxlflmsjDYL-t7p61atDVjwNWCax3-3Ovo6AJcBlvhw" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/labels/:id
PUT /1.1/771/labels/176
Accept: application/json
Content-Type: application/json
Authorization: Bearer nxlflmsjDYL-t7p61atDVjwNWCax3-3Ovo6AJcBlvhw
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": 176,
"name": "updated name",
"sequence": 1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7-fe0f.png",
"active": true,
"created_at": "2025-02-07T12:58:55+01:00",
"updated_at": "2025-02-07T12:58:55+01:00",
"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/782/users/current/permissions" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer WWzCdwYdOhB7pffWMoKzbNWuBjnq3j80LATG3T2Oaaw" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current/permissions
GET /1.1/782/users/current/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer WWzCdwYdOhB7pffWMoKzbNWuBjnq3j80LATG3T2Oaaw
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": "account",
"permissions": [
"create",
"read",
"update",
"manage_plan",
"manage_subscriptions",
"manage_dev"
]
},
{
"resource": "company",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "day_property",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "forecast",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "invoice",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "label",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "project",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "report",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "team",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "user",
"permissions": [
"create",
"delete",
"notify",
"read",
"update"
]
}
]
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/783/users/1938/permissions" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer h0thq9IuD4yGQU7OwYDEDIDYMSFFhJaAkzI3uVd5578" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/permissions
GET /1.1/783/users/1938/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer h0thq9IuD4yGQU7OwYDEDIDYMSFFhJaAkzI3uVd5578
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": "account",
"permissions": [
"create",
"read",
"update",
"manage_plan",
"manage_subscriptions",
"manage_dev"
]
},
{
"resource": "company",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "day_property",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "forecast",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "invoice",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "label",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "project",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "report",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "team",
"permissions": [
"create",
"delete",
"read",
"update"
]
},
{
"resource": "user",
"permissions": [
"create",
"delete",
"notify",
"read",
"update"
]
}
]
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/789/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","lock_hours_in":0,"description":"Project Description","client_id":538,"budget_type":"M","budget":300,"users":[{"user_id":1950}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":177,"required":true},{"label_id":178,"required":true},{"label_id":179,"required":false},{"label_id":180,"required":false}]},"name":null}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer td8YDiULrGpV4BI1OFwl30ngBA8q2xNIXLchwhcloU8" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects
POST /1.1/789/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer td8YDiULrGpV4BI1OFwl30ngBA8q2xNIXLchwhcloU8
Parameters
{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","enable_labels":"all","lock_hours_in":0,"description":"Project Description","client_id":538,"budget_type":"M","budget":300,"users":[{"user_id":1950}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":177,"required":true},{"label_id":178,"required":true},{"label_id":179,"required":false},{"label_id":180,"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“ |
| team_ids | Specifies the project teams, should be array of numerical team id's. Example values: team_ids: [3,4,2] |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 757,
"active": true,
"account_id": 789,
"name": "New Project",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929536,
"updated_at": 1738929536,
"external_id": null,
"budget_scope": null,
"client": {
"id": 538,
"name": "Optio et repellat expedita.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:56+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": true,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 300,
"budget_type": "M",
"budget_calculation": "completed",
"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": 1950,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2025-02-07T12:58:56+01:00",
"created_at": "2025-02-07T12:58:56+01:00",
"deleted": false,
"internal_hour_rate": 0,
"internal_hour_rate_in_cents": 0
}
],
"labels": [
{
"project_id": 757,
"label_id": 177,
"budget": 0,
"required": true,
"default": false,
"updated_at": "2025-02-07T12:58:56+01:00"
},
{
"project_id": 757,
"label_id": 178,
"budget": 0,
"required": true,
"default": false,
"updated_at": "2025-02-07T12:58:56+01:00"
},
{
"project_id": 757,
"label_id": 179,
"budget": 0,
"required": false,
"default": false,
"updated_at": "2025-02-07T12:58:56+01:00"
},
{
"project_id": 757,
"label_id": 180,
"budget": 0,
"required": false,
"default": false,
"updated_at": "2025-02-07T12:58:56+01:00"
}
],
"label_ids": [
177,
178,
179,
180
],
"required_label_ids": [
177,
178
],
"default_label_ids": [],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"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": "2025-02-07T12:58:56+01:00"
},
"created_from": "Timely"
}
Delete a project
Request
curl "https://api.timelyapp.com/1.1/790/projects/758" -d '' -X DELETE \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer vQzNX2d9Jl4tbyuPUXz_XXHm3cA4CBQtWb4hBqYMNU4" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/projects/:id
DELETE /1.1/790/projects/758
Accept: application/json
Content-Type: application/json
Authorization: Bearer vQzNX2d9Jl4tbyuPUXz_XXHm3cA4CBQtWb4hBqYMNU4
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/792/projects" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer RutqKLXKE4st6PpZDMVx_W8Wf2ts3mXoWLycrIZe9rA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects
GET /1.1/792/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer RutqKLXKE4st6PpZDMVx_W8Wf2ts3mXoWLycrIZe9rA
Parameters
| Name | Description |
|---|---|
| offset | Retrieve projects from offset |
| limit | Retrieve number of projects |
| sort | Field to sort projects by - updated_at, id, name (Default updated_at) |
| order | Sorting order - desc, asc (Default desc) |
| filter | Filter projects - mine, active, archived, all (Default mine) |
| updated_after | Retrieve records updated after a certain timestamp |
| project_ids | Retrieve specific projects |
| external_ids | Retrieve specific projects by external ID reference |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 760,
"active": true,
"account_id": 792,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929536,
"updated_at": 1738929536,
"external_id": null,
"budget_scope": null,
"client": {
"id": 541,
"name": "Temporibus similique eum ipsam.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:56+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": 1956,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2025-02-07T12:58:56+01:00",
"created_at": "2025-02-07T12:58:56+01:00",
"deleted": false,
"internal_hour_rate": 0,
"internal_hour_rate_in_cents": 0
}
],
"labels": [],
"label_ids": [],
"required_label_ids": [],
"default_label_ids": [],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"created_from": "Web"
}
]
Retrieve a project Retrieve a single project by using its ID.
Request
curl -g "https://api.timelyapp.com/1.1/791/projects/759" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer KDr2zDGi92R4o1X5oc10IhffpI_-gOFbqCABy-0TbXc" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:id
GET /1.1/791/projects/759
Accept: application/json
Content-Type: application/json
Authorization: Bearer KDr2zDGi92R4o1X5oc10IhffpI_-gOFbqCABy-0TbXc
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": 759,
"active": true,
"account_id": 791,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929536,
"updated_at": 1738929536,
"external_id": null,
"budget_scope": null,
"client": {
"id": 540,
"name": "Optio dolor incidunt beatae.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:56+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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": 1954,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2025-02-07T12:58:56+01:00",
"created_at": "2025-02-07T12:58:56+01:00",
"deleted": false,
"internal_hour_rate": 0,
"internal_hour_rate_in_cents": 0
}
],
"labels": [],
"label_ids": [],
"required_label_ids": [],
"default_label_ids": [],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"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,
"locked_hours": false,
"created_from": "Web"
}
Update a project
Request
curl "https://api.timelyapp.com/1.1/794/projects/762" -d '{"project":{"name":"updated project name","name":null}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Nmbqx7_32y0AoqECCf2WBvIO-xiHTYoMol7oQ_K6vak" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:id
PUT /1.1/794/projects/762
Accept: application/json
Content-Type: application/json
Authorization: Bearer Nmbqx7_32y0AoqECCf2WBvIO-xiHTYoMol7oQ_K6vak
Parameters
{"project":{"name":"updated project name","name":null}}
| Name | Description |
|---|---|
| id required | Project ID |
| project | Project attributes |
| project[name] required | Specifies the project name |
| project[active] | Example values: “true” or “false”. Using “false” changes the project state to “archived” |
| project[color] required | Specifies the project color. It should be one of these: 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0 |
| project[client_id] required | Specifies the numerical client ID |
| project[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 }] |
| project[billable] | Specifies whether the project is billable or not. It should be “true” or “false” |
| project[budget] | Specifies the budget for the project. It should be numeric value |
| project[hour_rate] | Specifies the hourly rate for the project. It should be numeric value |
| project[rate_type] | Specifies the hourly rate type for the project. It should be “user” or “project” |
| project[external_id] | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
| project[send_invite] | Specifies if you want to send a project invite email. It should be “true” or “false” |
| project[required_notes] | Project hours notes to be required for logging |
| project[required_labels] | Project hours with atleast one label to be required for logging |
| project[enable_labels] | Specifies the way labels will be allowed for logging the project. It should be “all”, “none” or “custom” |
| project[invoice_by_budget] | Specifies if the project's invoices are based on its budget instead of hours. It should be “true“ or “false“. |
| update_existing_hours | Specifies if the rates of existing hours in the project should be updated. It should be "true" or "false". Default: true |
| update_unbilled_only | Specifies if only the rates of unbilled hours in the project should be updated. It is ignored if "update_existing_hours" is false. It should be "true" or "false". Default: false |
| team_ids | Specifies the project teams, should be array of numerical team id's. Example values: team_ids: [3,4,2] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 762,
"active": true,
"account_id": 794,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929537,
"updated_at": 1738929537,
"external_id": null,
"budget_scope": null,
"client": {
"id": 543,
"name": "Natus et facere velit.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:58:57+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "none",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "pending",
"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": 1960,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2025-02-07T12:58:57+01:00",
"created_at": "2025-02-07T12:58:57+01:00",
"deleted": false,
"internal_hour_rate": 0,
"internal_hour_rate_in_cents": 0
}
],
"labels": [],
"label_ids": [],
"required_label_ids": [],
"default_label_ids": [],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"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,
"currency_code": "usd"
},
"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,
"created_from": "Web"
}
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/830/reports" -d '{"user_ids":"2065","since":"2018-01-01","until":"2019-01-01","project_ids":"847"}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer F2THwqgaH3YgbTPVMNCthL0OdN-PV-LxEHD6-WJ_evA" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports
POST /1.1/830/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer F2THwqgaH3YgbTPVMNCthL0OdN-PV-LxEHD6-WJ_evA
Parameters
{"user_ids":"2065","since":"2018-01-01","until":"2019-01-01","project_ids":"847"}
| 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] or "751,117". Result will include any of provided values. |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 579,
"name": "Quos qui et necessitatibus.",
"projects": [
{
"id": 847,
"active": true,
"account_id": 830,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929544,
"updated_at": 1738929544,
"external_id": null,
"budget_scope": null,
"client": {
"id": 579,
"name": "Quos qui et necessitatibus.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:59:04+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 0,
"created_from": "Web"
}
],
"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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 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/831/reports/filter" -d '{"user_ids":"2067","since":"2018-01-01","until":"2019-01-01","project_ids":"848"}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer hXIGKWJgY3PltydYGr79-dWxYWuNO5rLmIHSVaWGnUA" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports/filter
POST /1.1/831/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer hXIGKWJgY3PltydYGr79-dWxYWuNO5rLmIHSVaWGnUA
Parameters
{"user_ids":"2067","since":"2018-01-01","until":"2019-01-01","project_ids":"848"}
| 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] or "3,4,2". Result will include any of provided values. |
| 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). |
| locked | Retrieve locked hours only. Example: locked=true |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"multiple_currency_report": false,
"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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 0
},
"clients": [
{
"id": 580,
"name": "Sit sint unde harum.",
"projects": [
{
"id": 848,
"active": true,
"account_id": 831,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1738929544,
"updated_at": 1738929544,
"external_id": null,
"budget_scope": null,
"client": {
"id": 580,
"name": "Sit sint unde harum.",
"active": true,
"external_id": null,
"updated_at": "2025-02-07T12:59:04+01:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"default_labels": false,
"currency": {
"id": "usd",
"name": "United States Dollar",
"iso_code": "USD",
"symbol": "$",
"symbol_first": true
},
"team_ids": [],
"budget": 0,
"budget_type": "",
"budget_calculation": "completed",
"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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 0,
"created_from": "Web"
}
],
"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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 0
}
],
"users": [
{
"id": 2067,
"email": "marijahxffarwe@timelyapp.com",
"name": "Marija Petrovic",
"time_zone": "Europe/Paris",
"updated_at": 1738929544,
"active": false,
"deleted": false,
"memory_onboarded": true,
"day_view_onboarded": true,
"last_received_memories_date": null,
"date_format": "dmy",
"time_format": "24",
"memory_retention_days": null,
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/58b9a41eab709ea162d4a50659b32f96?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/58b9a41eab709ea162d4a50659b32f96?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/58b9a41eab709ea162d4a50659b32f96?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/58b9a41eab709ea162d4a50659b32f96?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/58b9a41eab709ea162d4a50659b32f96?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 0,
"capacity": {
"hours": 2096,
"minutes": 0,
"seconds": 0.0,
"formatted": "2096:00",
"total_hours": 2096.0,
"total_seconds": 7545600.0,
"total_minutes": 125760.0
},
"overtime": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"undertime": {
"hours": 2091,
"minutes": 0,
"seconds": 0.0,
"formatted": "2091:00",
"total_hours": 2091.0,
"total_seconds": 7527600.0,
"total_minutes": 125460.0
}
}
],
"labels": [
{
"id": 0,
"name": "Untagged",
"sequence": -1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7.png",
"active": true,
"created_at": null,
"updated_at": null,
"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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 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
},
"billable_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 37500,
"formatted": "$375.00",
"amount": 375.0,
"currency_code": "usd"
},
"profit": {
"fractional": -12500,
"formatted": "$-125.00",
"amount": -125.0,
"currency_code": "usd"
},
"profitability": 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
},
"billable_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 37500,
"formatted": "$375.00",
"amount": 375.0,
"currency_code": "usd"
},
"profit": {
"fractional": -12500,
"formatted": "$-125.00",
"amount": -125.0,
"currency_code": "usd"
},
"profitability": 0
}
],
"teams": [
{
"id": 0,
"name": "No team",
"color": "866b9c",
"emoji": "https://emoji.memorycdn.com/tw64/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
},
"billable_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0,
"currency_code": "usd"
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0,
"currency_code": "usd"
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0,
"currency_code": "usd"
},
"internal_cost": {
"fractional": 75000,
"formatted": "$750.00",
"amount": 750.0,
"currency_code": "usd"
},
"profit": {
"fractional": -25000,
"formatted": "$-250.00",
"amount": -250.0,
"currency_code": "usd"
},
"profitability": 0,
"capacity": {
"hours": 2096,
"minutes": 0,
"seconds": 0.0,
"formatted": "2096:00",
"total_hours": 2096.0,
"total_seconds": 7545600.0,
"total_minutes": 125760.0
},
"overtime": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"undertime": {
"hours": 2091,
"minutes": 0,
"seconds": 0.0,
"formatted": "2091:00",
"total_hours": 2091.0,
"total_seconds": 7527600.0,
"total_minutes": 125460.0
}
}
]
}
Roles
List roles
Note: default attribute shows which role to select by default
Request
curl -g "https://api.timelyapp.com/1.1/832/roles" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer vVbe5ABrCmncu6aQaQJhfxYOExDaFHRoCKsG-hZuYfU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/roles
GET /1.1/832/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer vVbe5ABrCmncu6aQaQJhfxYOExDaFHRoCKsG-hZuYfU
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which roles are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 3329,
"name": "admin",
"display_name": "Admin",
"description": "Can see, create and edit all hours, projects and teams.",
"scopes": [
{
"name": "hide_hourly_rate",
"display_name": "Hide billable rate",
"description": "Hide hourly rates for this user",
"default": false,
"options": [
false
]
},
{
"name": "hide_internal_hourly_rate",
"display_name": "Hide cost rate",
"description": "Hide internal hourly rates for this user",
"default": false,
"options": [
false
]
}
],
"default": false,
"allowed_to_invite": true
},
{
"id": 3331,
"name": "employee",
"display_name": "Employee",
"description": "Can only see, log and edit their own hours.",
"scopes": [
{
"name": "hide_hourly_rate",
"display_name": "Hide billable rate",
"description": "Hide hourly rates for this user",
"default": false,
"options": [
true,
false
]
},
{
"name": "hide_internal_hourly_rate",
"display_name": "Hide cost rate",
"description": "Hide internal hourly rates for this user",
"default": true,
"options": [
true,
false
]
}
],
"default": false,
"allowed_to_invite": true
},
{
"id": 3330,
"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 billable rate",
"description": "Hide hourly rates for this user",
"default": false,
"options": [
true,
false
]
},
{
"name": "hide_internal_hourly_rate",
"display_name": "Hide cost rate",
"description": "Hide internal hourly rates for this user",
"default": true,
"options": [
true,
false
]
}
],
"default": true,
"allowed_to_invite": true
},
{
"id": 3332,
"name": "team_lead",
"display_name": "Team Lead",
"description": "Can see, log and edit hours for anyone from the team they lead",
"scopes": [
{
"name": "hide_hourly_rate",
"display_name": "Hide billable rate",
"description": "Hide hourly rates for this user",
"default": false,
"options": [
true,
false
]
},
{
"name": "hide_internal_hourly_rate",
"display_name": "Hide cost rate",
"description": "Hide internal hourly rates for this user",
"default": true,
"options": [
true,
false
]
}
],
"default": false,
"allowed_to_invite": false
}
]
Teams
The team object shows all teams available on an account.
Create a team
Request
curl "https://api.timelyapp.com/1.1/855/teams" -d '{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2115,"lead":true},{"user_id":2117,"lead":false}]}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer -O8G9d5GIjIUa-Q7SrrKCNTQVhbVBS9uiUuioDjQ3sE" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/teams
POST /1.1/855/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer -O8G9d5GIjIUa-Q7SrrKCNTQVhbVBS9uiUuioDjQ3sE
Parameters
{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2115,"lead":true},{"user_id":2117,"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": 62,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"project_ids": [],
"user_ids": [
2115,
2117
],
"users": [
{
"id": 75,
"user_id": 2115,
"team_id": 62,
"lead": true,
"hide_hours": false
},
{
"id": 76,
"user_id": 2117,
"team_id": 62,
"lead": false,
"hide_hours": false
}
]
}
Delete a team
Request
curl "https://api.timelyapp.com/1.1/856/teams/63" -d '' -X DELETE \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 8MtjP8-EcaU0-hLgskN37tWrZ--3x0tD6Rd63eOGL3E" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/teams/:id
DELETE /1.1/856/teams/63
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8MtjP8-EcaU0-hLgskN37tWrZ--3x0tD6Rd63eOGL3E
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 |
| delete_project_users | Specifies if associated users should be removed from team projects. For example: "delete_project_users":true. Default: false |
Response
Content-Type: application/json; charset=utf-8
200 OK
{}
List all teams
Request
curl -g "https://api.timelyapp.com/1.1/858/teams" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer j1XP8mkwvg9Sx_MkcCx-IMo0MumS8xt9OOZIlkl_DKI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams
GET /1.1/858/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer j1XP8mkwvg9Sx_MkcCx-IMo0MumS8xt9OOZIlkl_DKI
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": 65,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"project_ids": [],
"user_ids": [],
"users": []
}
]
Retrieve a team
Request
curl -g "https://api.timelyapp.com/1.1/857/teams/64" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer liWZ3r0uZ-m7iDv9G8UDiywmeyxJr6vrlVseSS-RJcM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams/:id
GET /1.1/857/teams/64
Accept: application/json
Content-Type: application/json
Authorization: Bearer liWZ3r0uZ-m7iDv9G8UDiywmeyxJr6vrlVseSS-RJcM
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": 64,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"project_ids": [],
"user_ids": [],
"users": []
}
Update a team
Request
curl "https://api.timelyapp.com/1.1/859/teams/66" -d '{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2124,"lead":true}]}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer KCe5hmjmV9QVwOvYFRu1lEnpZWvSzDlqcAbml0m8ZGE" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/teams/:id
PUT /1.1/859/teams/66
Accept: application/json
Content-Type: application/json
Authorization: Bearer KCe5hmjmV9QVwOvYFRu1lEnpZWvSzDlqcAbml0m8ZGE
Parameters
{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2124,"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}] |
| add_users_to_team_projects | Specifies if the user should be added to team projects. For example: "add_users_to_team_projects":false. Default: true |
| delete_users_from_team_projects | Specifies if the removed user should be removed from team projects. For example: "delete_users_from_team_projects":true. Default: false |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 66,
"name": "Backend",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"project_ids": [],
"user_ids": [
2124
],
"users": [
{
"id": 77,
"user_id": 2124,
"team_id": 66,
"lead": true,
"hide_hours": false
}
]
}
UserCapacities
Retrieve capacities
See capacities of multiple users in the account
Request
curl -g "https://api.timelyapp.com/1.1/864/users/capacities" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 8eqgmYeLcjcIKO25OVVTcYmRtdaGhNVK3z4wV2CftmI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/capacities
GET /1.1/864/users/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8eqgmYeLcjcIKO25OVVTcYmRtdaGhNVK3z4wV2CftmI
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": 2134,
"capacities": [
{
"id": null,
"weekly_capacity": 40.0,
"daily_capacity": 8.0,
"weekdays": "MO,TU,WE,TH,FR",
"work_days": "MON,TUE,WED,THU,FRI",
"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/863/users/2132/capacities" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer b-KgvDLILBWvrLhKeJ9fMRfuUnQZF9J9uJndCJGwjBI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/capacities
GET /1.1/863/users/2132/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer b-KgvDLILBWvrLhKeJ9fMRfuUnQZF9J9uJndCJGwjBI
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",
"work_days": "MON,TUE,WED,THU,FRI",
"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/866/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":882,"hour_rate":10}]},"name":null,"admin":{"id":528,"email":"notifications@timelyapp.com","created_at":"2025-02-07T11:59:10.000Z","updated_at":"2025-02-07T11:59:10.000Z","name":"Timely","notifier":true}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ppx3eBR_XEam6sN_xrUEMXQ2eCiyIU4dfWLU4vMteF0" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users
POST /1.1/866/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer ppx3eBR_XEam6sN_xrUEMXQ2eCiyIU4dfWLU4vMteF0
Parameters
{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":882,"hour_rate":10}]},"name":null,"admin":{"id":528,"email":"notifications@timelyapp.com","created_at":"2025-02-07T11:59:10.000Z","updated_at":"2025-02-07T11:59:10.000Z","name":"Timely","notifier":true}}
| 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 |
| internal_hour_rate | Specifies the internal hourly rate for users in the account |
| hide_internal_hourly_rate | The hide_internal_hourly_rate hides the internal hourly rate for users in the account. The default is true. For example: "hide_internal_hourly_rate": true |
| team_ids | Specifies the teams that the user will be part of, should be array of numerical team id's. Example values: team_ids: [3,4,2] |
| add_team_users_to_projects | Specifies if the user should be added to team projects Specified in team_ids. For example: "add_team_users_to_projects":false. Default: true |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 2140,
"email": "marija@timely.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": false,
"memory_onboarded": false,
"created_at": 1738929550,
"updated_at": 1738929550,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Etc/UTC",
"memory_retention_days": null,
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR",
"weekly_capacity": 40.0,
"user_level": "manager",
"admin": false,
"hide_hourly_rate": false,
"hide_internal_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"internal_hour_rate": 0.0,
"role_id": 3466,
"role": {
"id": 3466,
"name": "manager"
}
}
Delete a user
Request
curl "https://api.timelyapp.com/1.1/867/users/2141" -d '' -X DELETE \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 0ZMUyQ3RipN-TPuug6FruKJ7Py6xj10TpnKaHWld0y0" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/users/:id
DELETE /1.1/867/users/2141
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0ZMUyQ3RipN-TPuug6FruKJ7Py6xj10TpnKaHWld0y0
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 100 most recently updated users.
Request
curl -g "https://api.timelyapp.com/1.1/870/users" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer QrXwgAZhmCmMnMlZBDTDHndggP_WtKvMSi9LZajf1xM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users
GET /1.1/870/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer QrXwgAZhmCmMnMlZBDTDHndggP_WtKvMSi9LZajf1xM
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the users you want to retrieve |
| limit | Retrieve a limited number of users (Default 100) |
| offset | Retrieve users from offset |
| order | Sorting order on updated_at - desc, asc (Default desc) |
| filter | Filter users - active, deleted (Default active) |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 2147,
"email": "marijaiwbezapo@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1738929550,
"updated_at": 1738929550,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"memory_retention_days": null,
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/29d5a1cfee0b41d5e458f3b34e9284b9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/29d5a1cfee0b41d5e458f3b34e9284b9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/29d5a1cfee0b41d5e458f3b34e9284b9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/29d5a1cfee0b41d5e458f3b34e9284b9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/29d5a1cfee0b41d5e458f3b34e9284b9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/29d5a1cfee0b41d5e458f3b34e9284b9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR",
"weekly_capacity": 40.0,
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"hide_internal_hourly_rate": true,
"deleted": false,
"default_hour_rate": 0.0,
"internal_hour_rate": 0.0,
"role_id": 3481,
"role": {
"id": 3481,
"name": "admin"
}
}
]
Retrieve a user
Request
curl -g "https://api.timelyapp.com/1.1/868/users/2143" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ruz4EV9k6KhPgnD8zvVcKLjRROlvTRR6SihMON9QSbs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:id
GET /1.1/868/users/2143
Accept: application/json
Content-Type: application/json
Authorization: Bearer ruz4EV9k6KhPgnD8zvVcKLjRROlvTRR6SihMON9QSbs
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": 2143,
"email": "marijapatrvvsb@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1738929550,
"updated_at": 1738929550,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"memory_retention_days": null,
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/eaa16f901ce30054aba2230b2ea1eafa?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/eaa16f901ce30054aba2230b2ea1eafa?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/eaa16f901ce30054aba2230b2ea1eafa?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/eaa16f901ce30054aba2230b2ea1eafa?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/eaa16f901ce30054aba2230b2ea1eafa?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/eaa16f901ce30054aba2230b2ea1eafa?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR",
"weekly_capacity": 40.0,
"active_projects_count": 1,
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"hide_internal_hourly_rate": true,
"deleted": false,
"default_hour_rate": 0.0,
"internal_hour_rate": 0.0,
"role_id": 3473,
"role": {
"id": 3473,
"name": "admin"
}
}
Retrieve current user
Request
curl -g "https://api.timelyapp.com/1.1/869/users/current" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ko6uxUEaH4-Urs9_DHMpr54fgdokYiydSAYcjya7XA8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current
GET /1.1/869/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer ko6uxUEaH4-Urs9_DHMpr54fgdokYiydSAYcjya7XA8
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the current user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 2145,
"email": "marijaqpabkelc@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1738929550,
"updated_at": 1738929550,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"memory_retention_days": null,
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/cc358ca2a22b13e9a9b75fcd56cd468c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/cc358ca2a22b13e9a9b75fcd56cd468c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/cc358ca2a22b13e9a9b75fcd56cd468c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/cc358ca2a22b13e9a9b75fcd56cd468c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/cc358ca2a22b13e9a9b75fcd56cd468c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/cc358ca2a22b13e9a9b75fcd56cd468c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR",
"weekly_capacity": 40.0,
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"hide_internal_hourly_rate": true,
"deleted": false,
"default_hour_rate": 0.0,
"internal_hour_rate": 0.0,
"role_id": 3477,
"role": {
"id": 3477,
"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.
Request
curl "https://api.timelyapp.com/1.1/871/users/2149" -d '{"user":{"admin":{"id":533,"email":"notifications@timelyapp.com","created_at":"2025-02-07T11:59:11.000Z","updated_at":"2025-02-07T11:59:11.000Z","name":"Timely","notifier":true},"role_id":3485,"projects":[{"project_id":887,"hour_rate":10}]}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer B-s52LxmGdS7MLeRt7unvXJNhQCJVwuakrshVvxi5QU" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:id
PUT /1.1/871/users/2149
Accept: application/json
Content-Type: application/json
Authorization: Bearer B-s52LxmGdS7MLeRt7unvXJNhQCJVwuakrshVvxi5QU
Parameters
{"user":{"admin":{"id":533,"email":"notifications@timelyapp.com","created_at":"2025-02-07T11:59:11.000Z","updated_at":"2025-02-07T11:59:11.000Z","name":"Timely","notifier":true},"role_id":3485,"projects":[{"project_id":887,"hour_rate":10}]}}
| Name | Description |
|---|---|
| id required | The numerical ID of the user |
| user required | Label attributes |
| user[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 }] |
| user[role_id] required | Specifies the user's role in the account |
| user[user_level] | (Deprecated) Specifies the user level; either “normal” or “limited”. The default is "normal". For example: "user_level": "normal" |
| user[admin] | (Deprecated) Specifies the user is an admin. In this case user_level should be “normal”. For example: "admin": "true" |
| user[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. |
| user[add_to_all_projects] | Specifies whether the user should be added to all projects in the account. For example: "add_to_all_projects":true |
| user[internal_hour_rate] | Specifies the internal hourly rate for users in the account |
| user[hide_internal_hourly_rate] | The hide_internal_hourly_rate hides the internal hourly rate for users in the account. The default is true. For example: "hide_internal_hourly_rate": true |
| update_existing_hours | Specifies if the updated hour rate should be applied to existing hours. For example: "update_existing_hours":false. Default: true |
| update_unbilled_only | Specifies if the updated hour rate should only be applied to unbilled hours. This is ignored if "update_existing_hours" is false. For example: "update_unbilled_only":true. Default: false |
| update_existing_hours_internal_rate | Specifies if the updated internal hour rate should be applied to existing hours. For example: "update_existing_hours_internal_rate":false. Default: true |
| update_unbilled_hours_internal_rate | Specifies if the updated internal hour rate should only be applied to unbilled hours. This is ignored if "update_existing_hours_internal_rate" is false. For example: "update_unbilled_hours_internal_rate":true. Default: false |
| team_ids | Specifies the teams that the user will be part of, should be array of numerical team id's. Example values: team_ids: [3,4,2] |
| add_team_users_to_projects | Specifies if the user should be added to team projects Specified in team_ids. For example: "add_team_users_to_projects":false. Default: true |
| remove_team_users_from_projects | Specifies if the user should be removed from team projects not specified in team_ids. For example: "remove_team_users_from_projects":true. Default: false |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 2149,
"email": "marijagnfonogx@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1738929550,
"updated_at": 1738929550,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"memory_retention_days": null,
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8e2a49999c08c10f7aff1faf9005c303?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8e2a49999c08c10f7aff1faf9005c303?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/8e2a49999c08c10f7aff1faf9005c303?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8e2a49999c08c10f7aff1faf9005c303?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/8e2a49999c08c10f7aff1faf9005c303?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/8e2a49999c08c10f7aff1faf9005c303?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"work_days": "MON,TUE,WED,THU,FRI",
"weekdays": "MO,TU,WE,TH,FR",
"weekly_capacity": 40.0,
"user_level": "admin",
"admin": true,
"hide_hourly_rate": false,
"hide_internal_hourly_rate": false,
"deleted": false,
"default_hour_rate": 0.0,
"internal_hour_rate": 0.0,
"role_id": 3485,
"role": {
"id": 3485,
"name": "admin"
}
}
Webhooks
Webhooks allow external services to be notified when certain events happen. When the specified events happen, we’ll send a POST request to each of the URLs you provide.
Create a webhook
Request
curl "https://api.timelyapp.com/1.1/876/webhooks" -d '{"webhook":{"url":"https://thiel.io/ronni.abshire","subscriptions":["projects:created"],"active":true,"secret_token":"deadbeef"}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer tf52Tb_HkEfOJGYA0qYruq6jNnA-UZd4zeI_h9VTpdk" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/webhooks
POST /1.1/876/webhooks
Accept: application/json
Content-Type: application/json
Authorization: Bearer tf52Tb_HkEfOJGYA0qYruq6jNnA-UZd4zeI_h9VTpdk
Parameters
{"webhook":{"url":"https://thiel.io/ronni.abshire","subscriptions":["projects:created"],"active":true,"secret_token":"deadbeef"}}
| Name | Description |
|---|---|
| url required | The URL of the endpoint that will receive the webhook POST requests. (HTTPS required) |
| secret_token | Setting a webhook secret allows you to ensure that requests sent to the above webhook endpoint are from us. You'll receive a signature in the X-Signature header value. Calculate a SHA256 hash for the received payload using your provided SECRET_TOKEN on your end, and ensure that the result matches the X-Signature value. |
| subscriptions | Specifies the array of events should it listen to. The format is ['entity:action', ...]. Eg. ['project:created']. Use the wildcard (*) character for all events or all actions of an entity. Support subscriptions:
|
| active | By default, webhook deliveries are active. You can choose to disable the delivery of webhook payloads by disable this. |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 5,
"account_id": 876,
"url": "https://thiel.io/ronni.abshire",
"subscriptions": [
"projects:created"
],
"secret_token": "deadbeef",
"active": true,
"created_at": "2025-02-07T12:59:11+01:00",
"updated_at": "2025-02-07T12:59:11+01:00"
}
Delete a webhook
Request
curl "https://api.timelyapp.com/1.1/877/webhooks/6" -d '' -X DELETE \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer N0r73kkVIyqI9YV83jAqfN9ruVUsDid15-X6LfWsNiA" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/webhooks/:id
DELETE /1.1/877/webhooks/6
Accept: application/json
Content-Type: application/json
Authorization: Bearer N0r73kkVIyqI9YV83jAqfN9ruVUsDid15-X6LfWsNiA
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the webhook you want to delete |
| id | The ID of the webhook you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{}
List all webhooks
Request
curl -g "https://api.timelyapp.com/1.1/879/webhooks" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sCzTdjqFrrOvBaqu6sK9bsO4W_aaIyElMjaNJBqY7dY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/webhooks
GET /1.1/879/webhooks
Accept: application/json
Content-Type: application/json
Authorization: Bearer sCzTdjqFrrOvBaqu6sK9bsO4W_aaIyElMjaNJBqY7dY
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the webhooks you want to retrieve |
| offset | Retrieve webhooks from offset |
| limit | Retrieve number of webhooks |
Response
Content-Type: application/json; charset=utf-8
200 OK
[]
Retrieve a webhook
Request
curl -g "https://api.timelyapp.com/1.1/878/webhooks/7" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer J2-Pv0vSEU4_mcvEjKVt_ELF9BrLpWECBH1BNYOrZto" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/webhooks/:id
GET /1.1/878/webhooks/7
Accept: application/json
Content-Type: application/json
Authorization: Bearer J2-Pv0vSEU4_mcvEjKVt_ELF9BrLpWECBH1BNYOrZto
Parameters
| Name | Description |
|---|---|
| account_id | The account ID containing the webhook you want to retrieve |
| id | The ID of the webhook you want to retrieve |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 7,
"account_id": 878,
"url": "https://stracke-smith.com/lise",
"subscriptions": [
"projects:created"
],
"secret_token": null,
"active": true,
"created_at": "2025-02-07T12:59:12+01:00",
"updated_at": "2025-02-07T12:59:12+01:00"
}
Update a webhook
Request
curl "https://api.timelyapp.com/1.1/880/webhooks/8" -d '{"webhook":{"subscriptions":["projects:created","labels:created"],"secret_token":"deadbeef"}}' -X PUT \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer rbOiOYNHz2e6iAtJOduw4B8PUUJZvkB94wJjkVZanVc" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/webhooks/:id
PUT /1.1/880/webhooks/8
Accept: application/json
Content-Type: application/json
Authorization: Bearer rbOiOYNHz2e6iAtJOduw4B8PUUJZvkB94wJjkVZanVc
Parameters
{"webhook":{"subscriptions":["projects:created","labels:created"],"secret_token":"deadbeef"}}
| Name | Description |
|---|---|
| id required | Webhook ID |
| url required | The URL of the endpoint that will receive the webhook POST requests. (HTTPS required) |
| secret_token | Setting a webhook secret allows you to ensure that requests sent to the above webhook endpoint are from us. You'll receive a signature in the X-Signature header value. Calculate a SHA256 hash for the received payload using your provided SECRET_TOKEN on your end, and ensure that the result matches the X-Signature value. |
| subscriptions | Specifies the array of events should it listen to. The format is ['entity:action', ...]. Eg. ['projects:created']. Use the wildcard (*) character for all events or all actions of an entity. |
| active | Example values: "true" or "false" |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 8,
"account_id": 880,
"url": "https://nitzsche.co/edie",
"subscriptions": [
"projects:created",
"labels:created"
],
"secret_token": "deadbeef",
"active": true,
"created_at": "2025-02-07T12:59:12+01:00",
"updated_at": "2025-02-07T12:59:12+01:00"
}
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. |