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 Mnr_7cKCt_-AO_F7_Q3Glj1YyYPsqQLn48AM4UdNqjg" \
-H "Cookie: "
Endpoint
GET /1.1/accounts
GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer Mnr_7cKCt_-AO_F7_Q3Glj1YyYPsqQLn48AM4UdNqjg
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1083,
"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": 1083,
"plan_name": "Essential",
"next_charge": "2024-10-25",
"start_of_week": 0,
"created_at": 1727256751,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 2779,
"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": "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": "user_custom_properties",
"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/1081/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 n3Km7fr8dUkC3EKuLWfLEnb8ayTUnx4Gdu-qOv5oagM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/activities
GET /1.1/1081/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer n3Km7fr8dUkC3EKuLWfLEnb8ayTUnx4Gdu-qOv5oagM
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": 104,
"user": {
"id": 2774,
"email": "marijalrtrebhm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:30+02:00"
},
"message": "archived",
"activity_type": "archive_project",
"url": "http://app.timelyapp.local:3002/1081/projects/1082?type=archived_project",
"updated_at": "2024-09-18T11:32:31+02:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 1082,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 788,
"name": "Reiciendis magni aut omnis.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:31+02:00"
},
"updated_at": "2024-09-25T11:32:31+02:00"
},
"anomaly": false
},
{
"id": 103,
"user": {
"id": 2774,
"email": "marijalrtrebhm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/8499f7fe44dfe810bbb993578d72ee93?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:30+02:00"
},
"message": "50% of budget used",
"activity_type": "project_budget_progress_fifty",
"url": "http://app.timelyapp.local:3002/1081/projects/1082?type=budget_progress",
"updated_at": "2024-09-25T11:32:31+02:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 1082,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 788,
"name": "Reiciendis magni aut omnis.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:31+02:00"
},
"updated_at": "2024-09-25T11:32:31+02:00"
},
"anomaly": false
}
]
Retrieve an account
Returns one account object related to one company and one subscription plan.
Request
curl -g "https://api.timelyapp.com/1.1/accounts/1082" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer XyWMcaT4RMz2gzX8rUMaVrS-exgDrt2XD-dItcweHzE" \
-H "Cookie: "
Endpoint
GET /1.1/accounts/:id
GET /1.1/accounts/1082
Accept: application/json
Content-Type: application/json
Authorization: Bearer XyWMcaT4RMz2gzX8rUMaVrS-exgDrt2XD-dItcweHzE
Parameters
Name | Description |
---|---|
id | The id of the account to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1082,
"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": 1082,
"plan_name": "Essential",
"next_charge": "2024-10-25",
"start_of_week": 0,
"created_at": 1727256751,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 2777,
"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": "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": "user_custom_properties",
"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/1101/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 IOuVYMhyyohYZL5rQQpm_S2IItaiHxuvu1TL0gwR7rw" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/clients
POST /1.1/1101/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer IOuVYMhyyohYZL5rQQpm_S2IItaiHxuvu1TL0gwR7rw
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": 804,
"name": "Uniq name",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:34+02:00"
}
List all clients
NOTE: Client list will return recently updated 10000 clients. Additionally, you can add the “limit”, “offset”, “filter” and “order” optional parameters to change the result.
Request
curl -g "https://api.timelyapp.com/1.1/1102/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 A-AfmgyXHy0uPaRUbfKyGOQCrF8np3eYAA8N7EZiTDo" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients
GET /1.1/1102/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer A-AfmgyXHy0uPaRUbfKyGOQCrF8np3eYAA8N7EZiTDo
Parameters
Name | Description |
---|---|
account_id | Account ID for the clients you want to retrieve |
offset | Retrieve clients from offset |
limit | Retrieve number of clients |
show | Specifies which records to retrieve. The default shows a current account’s active clients (show=active). Example: "show=all" or "show=active" or "show=archived" |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 805,
"name": "Ea aperiam quia corporis.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:34+02:00",
"external_references": []
}
]
Show client
Request
curl -g "https://api.timelyapp.com/1.1/1104/clients/807" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer XuiKSFXaxpLOCJe6GO1lSKXqcbtz0Ff_VXA1fYKV6SQ" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients/:id
GET /1.1/1104/clients/807
Accept: application/json
Content-Type: application/json
Authorization: Bearer XuiKSFXaxpLOCJe6GO1lSKXqcbtz0Ff_VXA1fYKV6SQ
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": 807,
"name": "Blanditiis voluptas et voluptates.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:35+02:00",
"external_references": []
}
Update a client
Update client details just by using a client’s ID.
Request
curl "https://api.timelyapp.com/1.1/1106/clients/809" -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 gvNMLFpjiXWe6gXn8chKPaxvhFDqLK0L2tU6B_sKKA8" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/clients/:id
PUT /1.1/1106/clients/809
Accept: application/json
Content-Type: application/json
Authorization: Bearer gvNMLFpjiXWe6gXn8chKPaxvhFDqLK0L2tU6B_sKKA8
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": 809,
"name": "Updated name",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:35+02: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/1107/day_properties" -d '{"day_property":{"user_ids":[2832],"dates":["2024-09-25","2024-09-26"],"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 81MmFDmj7pFIiTAbz_x0Izl8DXW7do-6pOnJ0owZ9rU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/day_properties
POST /1.1/1107/day_properties
Accept: application/json
Content-Type: application/json
Authorization: Bearer 81MmFDmj7pFIiTAbz_x0Izl8DXW7do-6pOnJ0owZ9rU
Parameters
{"day_property":{"user_ids":[2832],"dates":["2024-09-25","2024-09-26"],"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": 19,
"user_id": 2832,
"account_id": 1107,
"date": "2024-09-25",
"locked": true,
"updated_at": 1727256755,
"created_at": 1727256755
},
{
"id": 20,
"user_id": 2832,
"account_id": 1107,
"date": "2024-09-26",
"locked": true,
"updated_at": 1727256755,
"created_at": 1727256755
}
]
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/1108/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 1PhxqnL1NwLtZHIp1vgS0a_CB-avwbsosuZIo2PmgRY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/day_properties
GET /1.1/1108/day_properties
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1PhxqnL1NwLtZHIp1vgS0a_CB-avwbsosuZIo2PmgRY
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": 21,
"user_id": 2834,
"account_id": 1108,
"date": "2024-09-25",
"locked": true,
"updated_at": 1727256755,
"created_at": 1727256755
},
{
"id": 22,
"user_id": 2834,
"account_id": 1108,
"date": "2024-09-26",
"locked": true,
"updated_at": 1727256755,
"created_at": 1727256755
}
]
Update Day locking
Update locked time by user_ids OR dates.
Request
curl "https://api.timelyapp.com/1.1/1109/day_properties" -d '{"day_property":{"user_ids":[2836],"dates":["2024-09-25","2024-09-26"],"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 WHX3hrJvUoVqV7OpnFCojHNfplp6cRYBQWBJhQ3pvCc" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/day_properties
PUT /1.1/1109/day_properties
Accept: application/json
Content-Type: application/json
Authorization: Bearer WHX3hrJvUoVqV7OpnFCojHNfplp6cRYBQWBJhQ3pvCc
Parameters
{"day_property":{"user_ids":[2836],"dates":["2024-09-25","2024-09-26"],"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": 23,
"user_id": 2836,
"account_id": 1109,
"date": "2024-09-25",
"locked": false,
"updated_at": 1727256756,
"created_at": 1727256756
},
{
"id": 24,
"user_id": 2836,
"account_id": 1109,
"date": "2024-09-26",
"locked": false,
"updated_at": 1727256756,
"created_at": 1727256756
}
]
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/1128/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:38.168+02:00","to":"2024-09-25T15:02:38.168+02:00","day":"2024-09-25","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":1112}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer XIKSQAjfMEVMPoW0wAfBAU_PvD5yNXlGlJEOOHfdAhc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/events
POST /1.1/1128/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer XIKSQAjfMEVMPoW0wAfBAU_PvD5yNXlGlJEOOHfdAhc
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:38.168+02:00","to":"2024-09-25T15:02:38.168+02:00","day":"2024-09-25","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":1112}}
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": 1759,
"uid": "ba1b3eba322eab5d895aa3023fe78b9c",
"user": {
"id": 2874,
"email": "marijaqapjaynq@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/3afe3dc6bb27da4f1d2018ea2905910d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/3afe3dc6bb27da4f1d2018ea2905910d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/3afe3dc6bb27da4f1d2018ea2905910d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3afe3dc6bb27da4f1d2018ea2905910d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/3afe3dc6bb27da4f1d2018ea2905910d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:38+02:00"
},
"project": {
"id": 1112,
"active": true,
"account_id": 1128,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256758,
"updated_at": 1727256758,
"external_id": null,
"budget_scope": null,
"client": {
"id": 819,
"name": "Occaecati tenetur in magni.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:38+02: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
},
"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": "2024-09-25",
"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": 1727256758,
"created_at": 1727256758,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:38+02:00",
"from": "2024-09-25T11:32:38+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 2874,
"updater_id": 2874,
"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,
"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/1127/projects/1111/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:37.949+02:00","to":"2024-09-25T15:02:37.949+02:00","day":"2024-09-25","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":1111}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jGQZEmfl9Pc7SRhaqZBUEM7Js3Tal8cRUMuWxfTnzow" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects/:project_id/events
POST /1.1/1127/projects/1111/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer jGQZEmfl9Pc7SRhaqZBUEM7Js3Tal8cRUMuWxfTnzow
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:37.949+02:00","to":"2024-09-25T15:02:37.949+02:00","day":"2024-09-25","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":1111}}
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": 1758,
"uid": "2612aa892d962d6f8056b195ca6e550d",
"user": {
"id": 2872,
"email": "marijaxvnshprv@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/c6ac3b115cf8073ef196a96cdfd7ec05?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/c6ac3b115cf8073ef196a96cdfd7ec05?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/c6ac3b115cf8073ef196a96cdfd7ec05?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/c6ac3b115cf8073ef196a96cdfd7ec05?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/c6ac3b115cf8073ef196a96cdfd7ec05?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:37+02:00"
},
"project": {
"id": 1111,
"active": true,
"account_id": 1127,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256757,
"updated_at": 1727256757,
"external_id": null,
"budget_scope": null,
"client": {
"id": 818,
"name": "Aut quis nostrum et.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:37+02: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
},
"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": "2024-09-25",
"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": 1727256757,
"created_at": 1727256757,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:37+02:00",
"from": "2024-09-25T11:32:37+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 2872,
"updater_id": 2872,
"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,
"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/1126/users/2870/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:37.697+02:00","to":"2024-09-25T15:02:37.697+02:00","day":"2024-09-25","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":2870}}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ImEqkJhP62aL449_gadMHnubJsOEQkh_yCaX1gg3Jcc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users/:user_id/events
POST /1.1/1126/users/2870/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer ImEqkJhP62aL449_gadMHnubJsOEQkh_yCaX1gg3Jcc
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:37.697+02:00","to":"2024-09-25T15:02:37.697+02:00","day":"2024-09-25","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":2870}}
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": 1757,
"uid": "d2cdf047a6674cef251d56544a3cf029",
"user": {
"id": 2870,
"email": "marijazjgynpxt@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/a0905abe4f040cd4bd85f91c254d1d5d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/a0905abe4f040cd4bd85f91c254d1d5d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/a0905abe4f040cd4bd85f91c254d1d5d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/a0905abe4f040cd4bd85f91c254d1d5d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/a0905abe4f040cd4bd85f91c254d1d5d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:37+02:00"
},
"project": {
"id": 1110,
"active": true,
"account_id": 1126,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256757,
"updated_at": 1727256757,
"external_id": null,
"budget_scope": null,
"client": {
"id": 817,
"name": "Ab sit eum delectus.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:37+02: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
},
"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": "2024-09-25",
"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": 1727256757,
"created_at": 1727256757,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:37+02:00",
"from": "2024-09-25T11:32:37+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 2870,
"updater_id": 2870,
"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,
"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/1125/bulk/events" -d '{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:37.463+02:00","to":"2024-09-25T15:02:37.463+02:00","day":"2024-09-25","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":2868,"account_id":1125,"project_id":1109}]}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer RRn4wgQkvmTxp6a3wzieQKpiSJeFJA2WoEcN2EeNgYI" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/1125/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer RRn4wgQkvmTxp6a3wzieQKpiSJeFJA2WoEcN2EeNgYI
Parameters
{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2024-09-25T11:32:37.463+02:00","to":"2024-09-25T15:02:37.463+02:00","day":"2024-09-25","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":2868,"account_id":1125,"project_id":1109}]}
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": [
1756
],
"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/1130/events/1761" -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 rKTIFC_P_PdBAuZNk6xbG1w_Pb96ypkF2AfbA73fg5E" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/events/:id
DELETE /1.1/1130/events/1761
Accept: application/json
Content-Type: application/json
Authorization: Bearer rKTIFC_P_PdBAuZNk6xbG1w_Pb96ypkF2AfbA73fg5E
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/1129/bulk/events" -d '{"delete":[1760]}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ZC4sryTu-5icawSVsLewUwlnAn4rAToa8CwyWt_oqwQ" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/1129/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer ZC4sryTu-5icawSVsLewUwlnAn4rAToa8CwyWt_oqwQ
Parameters
{"delete":[1760]}
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": [
1760
],
"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/1135/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 4UbzQrKG5WqB5ninAbRvPQohMR_VBMDtmSim0ps44xs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events
GET /1.1/1135/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4UbzQrKG5WqB5ninAbRvPQohMR_VBMDtmSim0ps44xs
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": 1766,
"uid": "96a93ba89a5b5c6c226e49b88973f46e",
"user": {
"id": 2888,
"email": "marijapehaqmft@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/9bfae37a6fd6cc6a509884a29ecd2188?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/9bfae37a6fd6cc6a509884a29ecd2188?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/9bfae37a6fd6cc6a509884a29ecd2188?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/9bfae37a6fd6cc6a509884a29ecd2188?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/9bfae37a6fd6cc6a509884a29ecd2188?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:39+02:00"
},
"project": {
"id": 1119,
"active": true,
"account_id": 1135,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256759,
"updated_at": 1727256759,
"external_id": null,
"budget_scope": null,
"client": {
"id": 826,
"name": "Velit commodi omnis recusandae.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:39+02: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
},
"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": "2024-09-25",
"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": 1727256759,
"created_at": 1727256759,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:39+02:00",
"from": "2024-09-25T11:32:39+02: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,
"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/1138/projects/1122/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 jx2narS3r3FNwygDB8FiuQt-M3pfZjlBIjl55i73Uhk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:project_id/events
GET /1.1/1138/projects/1122/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer jx2narS3r3FNwygDB8FiuQt-M3pfZjlBIjl55i73Uhk
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": 1769,
"uid": "7eb7eabbe9bd03c2fc99881d04da9cbd",
"user": {
"id": 2894,
"email": "marijakxeoecyp@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/5d452f127b1139a4daa58cc22ce5a667?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/5d452f127b1139a4daa58cc22ce5a667?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5d452f127b1139a4daa58cc22ce5a667?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5d452f127b1139a4daa58cc22ce5a667?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/5d452f127b1139a4daa58cc22ce5a667?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:40+02:00"
},
"project": {
"id": 1122,
"active": true,
"account_id": 1138,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256760,
"updated_at": 1727256760,
"external_id": null,
"budget_scope": null,
"client": {
"id": 829,
"name": "Non at laudantium repellendus.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:40+02: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
},
"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": "2024-09-25",
"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": 1727256760,
"created_at": 1727256760,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:40+02:00",
"from": "2024-09-25T11:32:40+02: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,
"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/1137/users/2892/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 Q8wqmFCejSsuovguTfUagzabOfbAPFRpKujHbimgy_E" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/events
GET /1.1/1137/users/2892/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q8wqmFCejSsuovguTfUagzabOfbAPFRpKujHbimgy_E
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": 1768,
"uid": "db29450c3f5e97f97846693611f98c15",
"user": {
"id": 2892,
"email": "marijaahalmqvl@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ddeaff212f2dd2b89ac331fb7e7a4e9b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ddeaff212f2dd2b89ac331fb7e7a4e9b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ddeaff212f2dd2b89ac331fb7e7a4e9b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ddeaff212f2dd2b89ac331fb7e7a4e9b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ddeaff212f2dd2b89ac331fb7e7a4e9b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:40+02:00"
},
"project": {
"id": 1121,
"active": true,
"account_id": 1137,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256760,
"updated_at": 1727256760,
"external_id": null,
"budget_scope": null,
"client": {
"id": 828,
"name": "Eligendi dolore vero aut.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:40+02: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
},
"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": "2024-09-25",
"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": 1727256760,
"created_at": 1727256760,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:40+02:00",
"from": "2024-09-25T11:32:40+02: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,
"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/1146/users/2910/events/1777" -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 QoQURFhTNb958ncVAUgXehln-VjeRKjLaEjRztAOzt0" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:user_id/events/:id
PUT /1.1/1146/users/2910/events/1777
Accept: application/json
Content-Type: application/json
Authorization: Bearer QoQURFhTNb958ncVAUgXehln-VjeRKjLaEjRztAOzt0
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": 1777,
"uid": "e9b73bccd1762555582b513ff9d02492",
"user": {
"id": 2910,
"email": "marijalvvqgvmp@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/10d02fb68078f225ba9ec74a05521061?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/10d02fb68078f225ba9ec74a05521061?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/10d02fb68078f225ba9ec74a05521061?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/10d02fb68078f225ba9ec74a05521061?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/10d02fb68078f225ba9ec74a05521061?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:42+02:00"
},
"project": {
"id": 1130,
"active": true,
"account_id": 1146,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256762,
"updated_at": 1727256762,
"external_id": null,
"budget_scope": null,
"client": {
"id": 837,
"name": "Molestiae esse voluptatibus vel.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:42+02: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
},
"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": "2024-09-25",
"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": 1727256762,
"created_at": 1727256762,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:42+02:00",
"from": "2024-09-25T11:32:42+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 2910,
"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,
"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/1145/projects/1129/events/1776" -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 Ybc0Xa1HklIfHD65bk4LlJItqWqWXyl4KSXJw8H-3Bg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:project_id/events/:id
PUT /1.1/1145/projects/1129/events/1776
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ybc0Xa1HklIfHD65bk4LlJItqWqWXyl4KSXJw8H-3Bg
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": 1776,
"uid": "7dd0240cd412efde8bc165e864d3644f",
"user": {
"id": 2908,
"email": "marijawgrgfowq@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/1c0b3b29bd3646087708f9856082898a?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/1c0b3b29bd3646087708f9856082898a?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/1c0b3b29bd3646087708f9856082898a?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/1c0b3b29bd3646087708f9856082898a?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/1c0b3b29bd3646087708f9856082898a?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:41+02:00"
},
"project": {
"id": 1129,
"active": true,
"account_id": 1145,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256761,
"updated_at": 1727256761,
"external_id": null,
"budget_scope": null,
"client": {
"id": 836,
"name": "Quibusdam libero inventore illo.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:41+02: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
},
"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": "2024-09-25",
"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": 1727256762,
"created_at": 1727256761,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:41+02:00",
"from": "2024-09-25T11:32:41+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 2908,
"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,
"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/1133/events/1764" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer LpQ4qpEJZ3dZcLFFCxUXZCazDXXLS6gwB58yuHp0OXU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events/:id
GET /1.1/1133/events/1764
Accept: application/json
Content-Type: application/json
Authorization: Bearer LpQ4qpEJZ3dZcLFFCxUXZCazDXXLS6gwB58yuHp0OXU
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": 1764,
"uid": "94e4451ad23909020c28b26ca3a13cb8",
"user": {
"id": 2884,
"email": "marijamepiomcj@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/647868b48de1ed95c4d6581b99572014?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/647868b48de1ed95c4d6581b99572014?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/647868b48de1ed95c4d6581b99572014?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/647868b48de1ed95c4d6581b99572014?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/647868b48de1ed95c4d6581b99572014?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:39+02:00"
},
"project": {
"id": 1117,
"active": true,
"account_id": 1133,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256759,
"updated_at": 1727256759,
"external_id": null,
"budget_scope": null,
"client": {
"id": 824,
"name": "Veritatis omnis ut quae.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:39+02: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
},
"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": "2024-09-25",
"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": 1727256759,
"created_at": 1727256759,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:39+02:00",
"from": "2024-09-25T11:32:39+02: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,
"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/1139/events/1770/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 veppGFf9CfcKaNID_y3fUomlzkhKouc1TI8N24AFfTg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/start
PUT /1.1/1139/events/1770/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer veppGFf9CfcKaNID_y3fUomlzkhKouc1TI8N24AFfTg
Parameters
Name | Description |
---|---|
id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1770,
"uid": "e5a4d6bf330f23a8707bb0d6001dfbe8",
"user": {
"id": 2896,
"email": "marijaekelgjpo@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/267b00db34e0b7ce050450681573569f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/267b00db34e0b7ce050450681573569f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/267b00db34e0b7ce050450681573569f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/267b00db34e0b7ce050450681573569f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/267b00db34e0b7ce050450681573569f?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:40+02:00"
},
"project": {
"id": 1123,
"active": true,
"account_id": 1139,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256760,
"updated_at": 1727256760,
"external_id": null,
"budget_scope": null,
"client": {
"id": 830,
"name": "Voluptatem similique incidunt blanditiis.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:40+02: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
},
"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": "2024-09-25",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "start",
"timer_started_on": 1727256760,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1727256760,
"created_at": 1727256760,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:40+02:00",
"from": "2024-09-25T11:32:40+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 2896,
"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,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [
{
"id": 22,
"hour_id": 1770,
"from": "2024-09-25T08:02:40+02:00",
"to": "2024-09-25T11:32:40+02:00",
"entry_ids": []
}
],
"state": null,
"external_links": []
}
Stop timer on an event
Request
curl "https://api.timelyapp.com/1.1/1140/events/1771/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 slJ1N-66K0YpaUEVi8pUxz2WxEIB9C7HGDkXQSfJBas" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/stop
PUT /1.1/1140/events/1771/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer slJ1N-66K0YpaUEVi8pUxz2WxEIB9C7HGDkXQSfJBas
Parameters
Name | Description |
---|---|
id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1771,
"uid": "21be9a4bd4f81549a9d1d241981cec3c",
"user": {
"id": 2898,
"email": "marijaixdnsmmz@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/3659d4baa8762d5b901ac55a37bf0bfb?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/3659d4baa8762d5b901ac55a37bf0bfb?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/3659d4baa8762d5b901ac55a37bf0bfb?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3659d4baa8762d5b901ac55a37bf0bfb?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/3659d4baa8762d5b901ac55a37bf0bfb?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:40+02:00"
},
"project": {
"id": 1124,
"active": true,
"account_id": 1140,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256760,
"updated_at": 1727256760,
"external_id": null,
"budget_scope": null,
"client": {
"id": 831,
"name": "Quae iste similique maiores.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:40+02: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
},
"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": "2024-09-25",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "stop",
"timer_started_on": 0,
"timer_stopped_on": 1727256760,
"label_ids": [],
"user_ids": [],
"updated_at": 1727256760,
"created_at": 1727256760,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:40+02:00",
"from": "2024-09-25T11:32:40+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 2898,
"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,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": [],
"state": null,
"external_links": []
}
Update an event
Request
curl "https://api.timelyapp.com/1.1/1144/events/1775" -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 tTEXeakDy9GyrTcYnU_II1HeSP50gwSaI48e1wcNL0s" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id
PUT /1.1/1144/events/1775
Accept: application/json
Content-Type: application/json
Authorization: Bearer tTEXeakDy9GyrTcYnU_II1HeSP50gwSaI48e1wcNL0s
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": 1775,
"uid": "36d7534290610d9b7e9abed244dd2f28",
"user": {
"id": 2906,
"email": "marijawktxjiiq@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/9c51eb058b127b90e8fed486f81dad91?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/9c51eb058b127b90e8fed486f81dad91?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/9c51eb058b127b90e8fed486f81dad91?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/9c51eb058b127b90e8fed486f81dad91?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/9c51eb058b127b90e8fed486f81dad91?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:41+02:00"
},
"project": {
"id": 1128,
"active": true,
"account_id": 1144,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256761,
"updated_at": 1727256761,
"external_id": null,
"budget_scope": null,
"client": {
"id": 835,
"name": "Rem deserunt dolores pariatur.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:41+02: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
},
"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": "2024-09-25",
"note": "Updated notes",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1727256761,
"created_at": 1727256761,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2024-09-25T15:02:41+02:00",
"from": "2024-09-25T11:32:41+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 2906,
"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,
"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/1141/bulk/events" -d '{"update":[{"id":1772,"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 6Z56fUNVsASfyJg0xYvTvesikB1Rbdk8C-qv_Ha62fU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/1141/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6Z56fUNVsASfyJg0xYvTvesikB1Rbdk8C-qv_Ha62fU
Parameters
{"update":[{"id":1772,"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": [
1772
],
"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/1178/forecasts" -d '{"forecast":{"creator_id":null,"updater_id":null,"from":"2022-05-10","to":"2022-05-16","estimated_minutes":150,"users":[{"id":2973}],"project_id":1145,"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 NaN9q7oBOWbPmS2Re27ToaUt9BGDKJbnya8ZaLNbvbE" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/forecasts
POST /1.1/1178/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer NaN9q7oBOWbPmS2Re27ToaUt9BGDKJbnya8ZaLNbvbE
Parameters
{"forecast":{"creator_id":null,"updater_id":null,"from":"2022-05-10","to":"2022-05-16","estimated_minutes":150,"users":[{"id":2973}],"project_id":1145,"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": 144,
"note": "Title",
"title": "Title",
"description": "",
"from": "2022-05-10",
"to": "2022-05-16",
"user": {
"id": 2973,
"email": "marijawzbmsscx@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:44+02: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": 2973,
"email": "marijawzbmsscx@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ecc91307fbdf0c9bc6d5c0cb910a242b?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:44+02: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": 1145,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 860,
"name": "Animi recusandae et quo.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:44+02:00"
},
"updated_at": "2024-09-25T11:32:44+02:00"
},
"estimated_minutes": 150,
"updated_at": "2024-09-25T11:32:44+02:00",
"created_at": "2024-09-25T11:32:44+02: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/1179/forecasts/145" -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 z4RoAEDt8Bn03B-CzJZvN6yxjqm78p1AieGKG4QBtlw" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/forecasts/:id
DELETE /1.1/1179/forecasts/145
Accept: application/json
Content-Type: application/json
Authorization: Bearer z4RoAEDt8Bn03B-CzJZvN6yxjqm78p1AieGKG4QBtlw
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/1180/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 XvE5dcNivfI9xOUZAzcGIIjHOuNlVODuEGzo1CX_ilA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/forecasts
GET /1.1/1180/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer XvE5dcNivfI9xOUZAzcGIIjHOuNlVODuEGzo1CX_ilA
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": 146,
"note": "title",
"title": "title",
"description": null,
"from": "2024-09-23",
"to": "2024-09-29",
"user": {
"id": 2980,
"email": "quentincdwdezrj@timelyapp.com",
"name": "Quintin Duponde",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/52dbba146d8c7ed48577a5680419098d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/52dbba146d8c7ed48577a5680419098d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/52dbba146d8c7ed48577a5680419098d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/52dbba146d8c7ed48577a5680419098d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/52dbba146d8c7ed48577a5680419098d?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:45+02: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": 2978,
"email": "marijafekwzelh@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/6a2c98a878c5ac8b31255a4dd53ef618?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/6a2c98a878c5ac8b31255a4dd53ef618?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/6a2c98a878c5ac8b31255a4dd53ef618?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/6a2c98a878c5ac8b31255a4dd53ef618?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/6a2c98a878c5ac8b31255a4dd53ef618?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:44+02: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": 1147,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 862,
"name": "Placeat asperiores illo qui.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:45+02:00"
},
"updated_at": "2024-09-25T11:32:45+02:00"
},
"estimated_minutes": 360,
"updated_at": "2024-09-25T11:32:45+02:00",
"created_at": "2024-09-25T11:32:45+02: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/1181/forecasts/147" -d '{"forecast":{"creator_id":null,"updater_id":null,"from":"2022-05-10","to":"2022-05-16","estimated_minutes":30,"users":[{"id":2981}],"project_id":1148,"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 hgBTbHDPYPeizwP4gZVfu98iTRc7T6gn6sEZf4USUbY" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/forecasts/:id
PUT /1.1/1181/forecasts/147
Accept: application/json
Content-Type: application/json
Authorization: Bearer hgBTbHDPYPeizwP4gZVfu98iTRc7T6gn6sEZf4USUbY
Parameters
{"forecast":{"creator_id":null,"updater_id":null,"from":"2022-05-10","to":"2022-05-16","estimated_minutes":30,"users":[{"id":2981}],"project_id":1148,"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": 147,
"note": "new title",
"title": "new title",
"description": "",
"from": "2022-05-10",
"to": "2022-05-16",
"user": {
"id": 2981,
"email": "marijajpwctqfm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:45+02: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": 2981,
"email": "marijajpwctqfm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/e5b0bf1a569e69494d64e8847f242e3c?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2024-09-25T11:32:45+02: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": 1148,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 863,
"name": "Consequuntur laudantium minus consequatur.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:45+02:00"
},
"updated_at": "2024-09-25T11:32:45+02:00"
},
"estimated_minutes": 30,
"updated_at": "2024-09-25T11:32:45+02:00",
"created_at": "2024-09-25T11:32:45+02: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/1219/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 DtlFPrx-_AfOLt0Ld6DJr3Q3aoORFNnKWVTyBYyuvP8" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/labels
POST /1.1/1219/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer DtlFPrx-_AfOLt0Ld6DJr3Q3aoORFNnKWVTyBYyuvP8
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": 109,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7-fe0f.png",
"active": true,
"created_at": "2024-09-25T11:32:48+02:00",
"updated_at": "2024-09-25T11:32:48+02:00",
"children": []
}
Delete a label
Request
curl "https://api.timelyapp.com/1.1/1220/labels/110" -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 33aVYn3YoPPcGLE0X-1Qt_oEAC-mn-cVgm-XAGw77Ac" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/labels/:id
DELETE /1.1/1220/labels/110
Accept: application/json
Content-Type: application/json
Authorization: Bearer 33aVYn3YoPPcGLE0X-1Qt_oEAC-mn-cVgm-XAGw77Ac
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/1223/labels?parent_id=112" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer A1o4FjtlgzTEETKDC-Ak5oQ0N89ndNDm4XM4Li4xYvg" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/1223/labels?parent_id=112
Accept: application/json
Content-Type: application/json
Authorization: Bearer A1o4FjtlgzTEETKDC-Ak5oQ0N89ndNDm4XM4Li4xYvg
Parameters
parent_id: 112
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": 112,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"active": true,
"created_at": "2024-09-25T11:32:49+02:00",
"updated_at": "2024-09-25T11:32:49+02:00",
"children": []
}
List all labels
Get all the tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/1222/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 tDrp_FTbZsgvtxkuZa_2SfJrB5BIQT7jY_3lViU-ly4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/1222/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer tDrp_FTbZsgvtxkuZa_2SfJrB5BIQT7jY_3lViU-ly4
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/1221/labels/111" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer UrnIgJp1BUZPiut0B5j1PoD1ulRhZC0YYyqRnX5sSp0" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels/:id
GET /1.1/1221/labels/111
Accept: application/json
Content-Type: application/json
Authorization: Bearer UrnIgJp1BUZPiut0B5j1PoD1ulRhZC0YYyqRnX5sSp0
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": 111,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"active": true,
"created_at": "2024-09-25T11:32:49+02:00",
"updated_at": "2024-09-25T11:32:49+02:00",
"children": []
}
Update a label
Request
curl "https://api.timelyapp.com/1.1/1224/labels/113" -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 fjNpHY7rqqOA5diAXoMSHg_zlR7-hSr-9PdACfhVKGg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/labels/:id
PUT /1.1/1224/labels/113
Accept: application/json
Content-Type: application/json
Authorization: Bearer fjNpHY7rqqOA5diAXoMSHg_zlR7-hSr-9PdACfhVKGg
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": 113,
"name": "updated name",
"sequence": 1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7-fe0f.png",
"active": true,
"created_at": "2024-09-25T11:32:49+02:00",
"updated_at": "2024-09-25T11:32:49+02: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/1235/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 5VrhVhSzUa5_DEqvTuqNJ5bLST_AtERpX_gZ2eKa18Y" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current/permissions
GET /1.1/1235/users/current/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5VrhVhSzUa5_DEqvTuqNJ5bLST_AtERpX_gZ2eKa18Y
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/1236/users/3089/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 TPBW66umz_0vWqq03r2MeeNhqrRClPAcdyuKm9gpqr0" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/permissions
GET /1.1/1236/users/3089/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer TPBW66umz_0vWqq03r2MeeNhqrRClPAcdyuKm9gpqr0
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/1242/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":906,"budget_type":"M","budget":300,"users":[{"user_id":3101}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":114,"required":true},{"label_id":115,"required":true},{"label_id":116,"required":false},{"label_id":117,"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 KcKP9TMM59C9Rs2wPWu0NQ0qwUpf5ko93N1vGyjhvL4" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects
POST /1.1/1242/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer KcKP9TMM59C9Rs2wPWu0NQ0qwUpf5ko93N1vGyjhvL4
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":906,"budget_type":"M","budget":300,"users":[{"user_id":3101}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":114,"required":true},{"label_id":115,"required":true},{"label_id":116,"required":false},{"label_id":117,"required":false}]},"name":null}
Name | Description |
---|---|
project required | Project attributes |
name required | Specifies the project name |
color required | Specifies the project color. Example values: 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0 |
client_id required | Specifies the numerical client ID |
users required | Specifies the project users. It should be an array of users, with numerical user IDs and an hour_rate. For example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }] |
billable | Specifies whether the project is billable or not. It should be “true” or “false” |
budget | Specifies the budget for the project. It should be numeric value |
hour_rate | Specifies the hourly rate for the project. It should be numeric valu |
rate_type | Specifies the hourly rate type for the project. It should be “user” or “project” |
external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
budget_recurrence | Specifies when a recurring budget will refresh |
send_invite | Specifies if you want to send a project invite email. It should be “true” or “false” |
required_notes | Project hours notes to be required for logging |
required_labels | Project hours with atleast one label to be required for logging |
labels | Specifies the project labels, should be array of labels with numerical label id and required flag Example: "labels": [{ "label_id": 1, "required": true }, { "label_id": 2, "required": false }] |
enable_labels | Specifies the way labels will be allowed for logging for the project. It should be “all”, “none” or “custom” |
invoice_by_budget | Specifies if the project's invoices are based on its budget instead of hours. It should be “true“ or “false“ |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 1181,
"active": true,
"account_id": 1242,
"name": "New Project",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256771,
"updated_at": 1727256771,
"external_id": null,
"budget_scope": null,
"client": {
"id": 906,
"name": "Similique aut laboriosam harum.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:51+02: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
},
"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": 3101,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2024-09-25T11:32:51+02:00",
"created_at": "2024-09-25T11:32:51+02:00",
"deleted": false,
"internal_hour_rate": 0,
"internal_hour_rate_in_cents": 0
}
],
"labels": [
{
"project_id": 1181,
"label_id": 114,
"budget": 0,
"required": true,
"default": false,
"updated_at": "2024-09-25T11:32:51+02:00"
},
{
"project_id": 1181,
"label_id": 115,
"budget": 0,
"required": true,
"default": false,
"updated_at": "2024-09-25T11:32:51+02:00"
},
{
"project_id": 1181,
"label_id": 116,
"budget": 0,
"required": false,
"default": false,
"updated_at": "2024-09-25T11:32:51+02:00"
},
{
"project_id": 1181,
"label_id": 117,
"budget": 0,
"required": false,
"default": false,
"updated_at": "2024-09-25T11:32:51+02:00"
}
],
"label_ids": [
114,
115,
116,
117
],
"required_label_ids": [
114,
115
],
"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": "2024-09-25T11:32:51+02:00"
},
"created_from": "Timely"
}
Delete a project
Request
curl "https://api.timelyapp.com/1.1/1243/projects/1182" -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 GuDnUWnRmXxgbwUVI5Xc0gSkuGVETzP-YiPl-8D1qV0" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/projects/:id
DELETE /1.1/1243/projects/1182
Accept: application/json
Content-Type: application/json
Authorization: Bearer GuDnUWnRmXxgbwUVI5Xc0gSkuGVETzP-YiPl-8D1qV0
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/1245/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 2kRGeuw9SZSY6BFkGBY73IFqXx619S0BGZ-MzcA3vXc" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects
GET /1.1/1245/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2kRGeuw9SZSY6BFkGBY73IFqXx619S0BGZ-MzcA3vXc
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": 1184,
"active": true,
"account_id": 1245,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256772,
"updated_at": 1727256772,
"external_id": null,
"budget_scope": null,
"client": {
"id": 909,
"name": "Error et architecto provident.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:52+02: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
},
"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": 3107,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2024-09-25T11:32:52+02:00",
"created_at": "2024-09-25T11:32:52+02: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/1244/projects/1183" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer LnGMY4qtnhDGWZlUNdJvFAftXQXhwiMrbVFuw35kw34" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:id
GET /1.1/1244/projects/1183
Accept: application/json
Content-Type: application/json
Authorization: Bearer LnGMY4qtnhDGWZlUNdJvFAftXQXhwiMrbVFuw35kw34
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": 1183,
"active": true,
"account_id": 1244,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256772,
"updated_at": 1727256772,
"external_id": null,
"budget_scope": null,
"client": {
"id": 908,
"name": "Nulla rem velit molestias.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:52+02: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
},
"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": 3105,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2024-09-25T11:32:52+02:00",
"created_at": "2024-09-25T11:32:52+02: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/1247/projects/1186" -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 yeH7meHxijW9A8Cu4WVN3xvd_qj7Xp7PXCKi6wU2vic" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:id
PUT /1.1/1247/projects/1186
Accept: application/json
Content-Type: application/json
Authorization: Bearer yeH7meHxijW9A8Cu4WVN3xvd_qj7Xp7PXCKi6wU2vic
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 |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1186,
"active": true,
"account_id": 1247,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256772,
"updated_at": 1727256772,
"external_id": null,
"budget_scope": null,
"client": {
"id": 911,
"name": "Sint aut dolorum deserunt.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:32:52+02: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
},
"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": 3111,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2024-09-25T11:32:52+02:00",
"created_at": "2024-09-25T11:32:52+02: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/1283/reports" -d '{"user_ids":"3216","since":"2018-01-01","until":"2019-01-01","project_ids":"1271"}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer F61RR3OHz5ozxzMnYBBbYQOawwuK7-5dkuNj_RICUSs" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports
POST /1.1/1283/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer F61RR3OHz5ozxzMnYBBbYQOawwuK7-5dkuNj_RICUSs
Parameters
{"user_ids":"3216","since":"2018-01-01","until":"2019-01-01","project_ids":"1271"}
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": 947,
"name": "Et voluptatibus maxime dicta.",
"projects": [
{
"id": 1271,
"active": true,
"account_id": 1283,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256781,
"updated_at": 1727256781,
"external_id": null,
"budget_scope": null,
"client": {
"id": 947,
"name": "Et voluptatibus maxime dicta.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:33:01+02: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
},
"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"
},
"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"
}
}
]
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/1284/reports/filter" -d '{"user_ids":"3218","since":"2018-01-01","until":"2019-01-01","project_ids":"1272"}' -X POST \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer hk9aoRcd7W3WMtcQO5S8rSVKKn-pHnipqrhdKdBtTW0" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports/filter
POST /1.1/1284/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer hk9aoRcd7W3WMtcQO5S8rSVKKn-pHnipqrhdKdBtTW0
Parameters
{"user_ids":"3218","since":"2018-01-01","until":"2019-01-01","project_ids":"1272"}
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"
}
},
"clients": [
{
"id": 948,
"name": "Corporis vel rerum ex.",
"projects": [
{
"id": 1272,
"active": true,
"account_id": 1284,
"name": "Timely",
"description": "Project Description",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"created_at": 1727256781,
"updated_at": 1727256781,
"external_id": null,
"budget_scope": null,
"client": {
"id": 948,
"name": "Corporis vel rerum ex.",
"active": true,
"external_id": null,
"updated_at": "2024-09-25T11:33:01+02: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
},
"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"
},
"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"
}
}
],
"users": [
{
"id": 3218,
"email": "marijahlnyfaqa@timelyapp.com",
"name": "Marija Petrovic",
"time_zone": "Europe/Paris",
"updated_at": 1727256781,
"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/edfddf7801849a41fd7dfd20bb31ab15?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/edfddf7801849a41fd7dfd20bb31ab15?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/edfddf7801849a41fd7dfd20bb31ab15?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/edfddf7801849a41fd7dfd20bb31ab15?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/edfddf7801849a41fd7dfd20bb31ab15?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"
},
"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"
}
}
],
"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"
}
},
{
"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"
}
}
],
"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"
},
"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/1285/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 A5jD51kbxyF9SyOyryg2CS6S6L0FFLdEb2Ru32b8QJA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/roles
GET /1.1/1285/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer A5jD51kbxyF9SyOyryg2CS6S6L0FFLdEb2Ru32b8QJA
Parameters
Name | Description |
---|---|
account_id | Account id for which roles are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 5137,
"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": 5139,
"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": 5138,
"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": 5140,
"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/1308/teams" -d '{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":3266,"lead":true},{"user_id":3268,"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 4KPLTXTVRCla3TCOKUmO59rXAWiPN4CESS4wwOBRXLs" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/teams
POST /1.1/1308/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4KPLTXTVRCla3TCOKUmO59rXAWiPN4CESS4wwOBRXLs
Parameters
{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":3266,"lead":true},{"user_id":3268,"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": 25,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
3266,
3268
],
"users": [
{
"id": 31,
"user_id": 3266,
"team_id": 25,
"lead": true
},
{
"id": 32,
"user_id": 3268,
"team_id": 25,
"lead": false
}
]
}
Delete a team
Request
curl "https://api.timelyapp.com/1.1/1309/teams/26" -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 gtUpOHgmY3iFdjXdiXM03qGPRrYgZhadN-BF3D6VmDg" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/teams/:id
DELETE /1.1/1309/teams/26
Accept: application/json
Content-Type: application/json
Authorization: Bearer gtUpOHgmY3iFdjXdiXM03qGPRrYgZhadN-BF3D6VmDg
Parameters
Name | Description |
---|---|
account_id | The account ID containing the team you want to delete |
id | The ID of the team you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{}
List all teams
Request
curl -g "https://api.timelyapp.com/1.1/1311/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 rTX-hFKupiu5Mhqu200k4BRzdrwWiej5F3-fZ3Pyqwk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams
GET /1.1/1311/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer rTX-hFKupiu5Mhqu200k4BRzdrwWiej5F3-fZ3Pyqwk
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": 28,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [],
"users": []
}
]
Retrieve a team
Request
curl -g "https://api.timelyapp.com/1.1/1310/teams/27" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer WHPQVpVo99QEMoTInRceWl1MXsTgV3grLMY-_DXW-TQ" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams/:id
GET /1.1/1310/teams/27
Accept: application/json
Content-Type: application/json
Authorization: Bearer WHPQVpVo99QEMoTInRceWl1MXsTgV3grLMY-_DXW-TQ
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": 27,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [],
"users": []
}
Update a team
Request
curl "https://api.timelyapp.com/1.1/1312/teams/29" -d '{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":3275,"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 0DpT29RC3Cuh8IeegoXjanxlIT0ya6nz-Ax1Te7kpi4" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/teams/:id
PUT /1.1/1312/teams/29
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0DpT29RC3Cuh8IeegoXjanxlIT0ya6nz-Ax1Te7kpi4
Parameters
{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":3275,"lead":true}]}}
Name | Description |
---|---|
name required | Specifies the team name |
emoji | Specifies the emoji url for a team |
color | Specifies the project color for a team |
external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
users required | Specific users with their role in the team. Ex: users:[{'user_id': 1, 'lead': true}] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 29,
"name": "Backend",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
3275
],
"users": [
{
"id": 33,
"user_id": 3275,
"team_id": 29,
"lead": true
}
]
}
UserCapacities
Retrieve capacities
See capacities of multiple users in the account
Request
curl -g "https://api.timelyapp.com/1.1/1317/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 lgv1xrzVVYS3XQDyDDFiO7YW7UAzTpv3VxIlzjaTABY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/capacities
GET /1.1/1317/users/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer lgv1xrzVVYS3XQDyDDFiO7YW7UAzTpv3VxIlzjaTABY
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": 3285,
"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/1316/users/3283/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 M4rLC_mN5TTp3PxYNreZLc7nc0j-qEjkZqlImf_vz5E" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/capacities
GET /1.1/1316/users/3283/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer M4rLC_mN5TTp3PxYNreZLc7nc0j-qEjkZqlImf_vz5E
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/1319/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":1306,"hour_rate":10}]},"name":null,"admin":{"id":1061,"email":"notifications@timelyapp.com","created_at":"2024-09-25T11:33:08.000+02:00","updated_at":"2024-09-25T11:33:08.000+02:00","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 p5T128DOENuyBMw_MTtR5HzTBl81bZQsUNxhyNWhcPU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users
POST /1.1/1319/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer p5T128DOENuyBMw_MTtR5HzTBl81bZQsUNxhyNWhcPU
Parameters
{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":1306,"hour_rate":10}]},"name":null,"admin":{"id":1061,"email":"notifications@timelyapp.com","created_at":"2024-09-25T11:33:08.000+02:00","updated_at":"2024-09-25T11:33:08.000+02:00","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 |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3291,
"email": "marija@timely.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": false,
"memory_onboarded": false,
"created_at": 1727256788,
"updated_at": 1727256788,
"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": 5274,
"role": {
"id": 5274,
"name": "manager"
}
}
Delete a user
Request
curl "https://api.timelyapp.com/1.1/1320/users/3292" -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 yrV-p6ROcSIgSPOvYvF01yk0Ucg3zjiEjDstzYFSgso" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/users/:id
DELETE /1.1/1320/users/3292
Accept: application/json
Content-Type: application/json
Authorization: Bearer yrV-p6ROcSIgSPOvYvF01yk0Ucg3zjiEjDstzYFSgso
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/1323/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 uUp5ad70kkvno9CpzaeDSQPBq813jSO6Qy1qjj6tRIE" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users
GET /1.1/1323/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer uUp5ad70kkvno9CpzaeDSQPBq813jSO6Qy1qjj6tRIE
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": 3298,
"email": "marijaxxfkmjln@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1727256789,
"updated_at": 1727256789,
"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/143e2dbd450b341923db270e3c00dd41?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/143e2dbd450b341923db270e3c00dd41?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/143e2dbd450b341923db270e3c00dd41?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/143e2dbd450b341923db270e3c00dd41?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/143e2dbd450b341923db270e3c00dd41?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/143e2dbd450b341923db270e3c00dd41?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": 5289,
"role": {
"id": 5289,
"name": "admin"
}
}
]
Retrieve a user
Request
curl -g "https://api.timelyapp.com/1.1/1321/users/3294" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer jiSlw8sAu27GCr3aGfp5hpxr6kyFoy7Gq9sAbig638w" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:id
GET /1.1/1321/users/3294
Accept: application/json
Content-Type: application/json
Authorization: Bearer jiSlw8sAu27GCr3aGfp5hpxr6kyFoy7Gq9sAbig638w
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": 3294,
"email": "marijaonqxaroz@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1727256789,
"updated_at": 1727256789,
"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/94382c4efd02cdf22269c8ae99239ede?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/94382c4efd02cdf22269c8ae99239ede?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/94382c4efd02cdf22269c8ae99239ede?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/94382c4efd02cdf22269c8ae99239ede?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/94382c4efd02cdf22269c8ae99239ede?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/94382c4efd02cdf22269c8ae99239ede?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": 5281,
"role": {
"id": 5281,
"name": "admin"
}
}
Retrieve current user
Request
curl -g "https://api.timelyapp.com/1.1/1322/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 sUt6vg5VPySQ28OtoFrJQW9J5jWj2wo6iU_e1A9IEeI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current
GET /1.1/1322/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer sUt6vg5VPySQ28OtoFrJQW9J5jWj2wo6iU_e1A9IEeI
Parameters
Name | Description |
---|---|
account_id | The account ID containing the current user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3296,
"email": "marijavpqoixnx@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1727256789,
"updated_at": 1727256789,
"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/62dde34a6eb0a8c4aec49b8f4f933c37?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/62dde34a6eb0a8c4aec49b8f4f933c37?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/62dde34a6eb0a8c4aec49b8f4f933c37?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/62dde34a6eb0a8c4aec49b8f4f933c37?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/62dde34a6eb0a8c4aec49b8f4f933c37?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/62dde34a6eb0a8c4aec49b8f4f933c37?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": 5285,
"role": {
"id": 5285,
"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/1324/users/3300" -d '{"user":{"admin":{"id":1066,"email":"notifications@timelyapp.com","created_at":"2024-09-25T11:33:10.000+02:00","updated_at":"2024-09-25T11:33:10.000+02:00","name":"Timely","notifier":true},"role_id":5293,"projects":[{"project_id":1311,"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 wzt82G8q_t-vo891fEZjAGH-xbFKtRwUYuWJTyMjmSw" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:id
PUT /1.1/1324/users/3300
Accept: application/json
Content-Type: application/json
Authorization: Bearer wzt82G8q_t-vo891fEZjAGH-xbFKtRwUYuWJTyMjmSw
Parameters
{"user":{"admin":{"id":1066,"email":"notifications@timelyapp.com","created_at":"2024-09-25T11:33:10.000+02:00","updated_at":"2024-09-25T11:33:10.000+02:00","name":"Timely","notifier":true},"role_id":5293,"projects":[{"project_id":1311,"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 |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 3300,
"email": "marijaeceyeikg@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1727256789,
"updated_at": 1727256789,
"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/daae28d1f1c4582d6304214ff76d42f9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/daae28d1f1c4582d6304214ff76d42f9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/daae28d1f1c4582d6304214ff76d42f9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/daae28d1f1c4582d6304214ff76d42f9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/daae28d1f1c4582d6304214ff76d42f9?d=http%3A%2F%2Fapp.timelyapp.local%3A3002%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/daae28d1f1c4582d6304214ff76d42f9?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": 5293,
"role": {
"id": 5293,
"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/1329/webhooks" -d '{"webhook":{"url":"https://nienow.org/reena","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 lEwsco5ocDddmPNrRZ8L05vmQnuU0wvS9zvBMunIZts" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/webhooks
POST /1.1/1329/webhooks
Accept: application/json
Content-Type: application/json
Authorization: Bearer lEwsco5ocDddmPNrRZ8L05vmQnuU0wvS9zvBMunIZts
Parameters
{"webhook":{"url":"https://nienow.org/reena","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": 13,
"account_id": 1329,
"url": "https://nienow.org/reena",
"subscriptions": [
"projects:created"
],
"secret_token": "deadbeef",
"active": true,
"created_at": "2024-09-25T11:33:10+02:00",
"updated_at": "2024-09-25T11:33:10+02:00"
}
Delete a webhook
Request
curl "https://api.timelyapp.com/1.1/1330/webhooks/14" -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 7plVEsRP8OZ5OMzZjSnWKRgxyVJ8o8XE03I0EZIBmHs" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/webhooks/:id
DELETE /1.1/1330/webhooks/14
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7plVEsRP8OZ5OMzZjSnWKRgxyVJ8o8XE03I0EZIBmHs
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/1332/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 jHby19I9124QvKDAJYjtdAMTbUPUyYAMyhCOPyrKoXE" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/webhooks
GET /1.1/1332/webhooks
Accept: application/json
Content-Type: application/json
Authorization: Bearer jHby19I9124QvKDAJYjtdAMTbUPUyYAMyhCOPyrKoXE
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/1331/webhooks/15" -X GET \
-H "Version: HTTP/1.0" \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YwXVrtFZQPY51HjydtPvIKaoYYq9oJWHmI_cDHG4FRw" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/webhooks/:id
GET /1.1/1331/webhooks/15
Accept: application/json
Content-Type: application/json
Authorization: Bearer YwXVrtFZQPY51HjydtPvIKaoYYq9oJWHmI_cDHG4FRw
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": 15,
"account_id": 1331,
"url": "https://brakus.io/curt",
"subscriptions": [
"projects:created"
],
"secret_token": null,
"active": true,
"created_at": "2024-09-25T11:33:11+02:00",
"updated_at": "2024-09-25T11:33:11+02:00"
}
Update a webhook
Request
curl "https://api.timelyapp.com/1.1/1333/webhooks/16" -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 LG52RPqPiiuHP-2-AxBkGqOO1CqhTvxCIAXVedJsciI" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/webhooks/:id
PUT /1.1/1333/webhooks/16
Accept: application/json
Content-Type: application/json
Authorization: Bearer LG52RPqPiiuHP-2-AxBkGqOO1CqhTvxCIAXVedJsciI
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": 16,
"account_id": 1333,
"url": "https://senger.name/bruno",
"subscriptions": [
"projects:created",
"labels:created"
],
"secret_token": "deadbeef",
"active": true,
"created_at": "2024-09-25T11:33:11+02:00",
"updated_at": "2024-09-25T11:33:11+02: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. |