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 "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6ENKm5ER8vuFP3F2ecqG-qODfUnzJMlNB73ft30GeRw" \
-H "Cookie: "
Endpoint
GET /1.1/accounts
GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6ENKm5ER8vuFP3F2ecqG-qODfUnzJMlNB73ft30GeRw
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1553,
"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": 1595,
"plan_name": "Essential",
"next_charge": "2022-07-16",
"start_of_week": 0,
"created_at": 1655387778,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 3789,
"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,
"report_columns_order": [
"budget",
"hour_date",
"name",
"email",
"logged_hours",
"estimated_hours",
"logged_money",
"estimated_money",
"hour_labels",
"hour_billed",
"hour_note",
"hour_from",
"hour_to",
"teams",
"external_id",
"billable_hours",
"non_billable_hours",
"internal_cost",
"estimated_internal_cost",
"task_title"
],
"task_report_columns_order": [
"title",
"description",
"status",
"username",
"estimated_hours",
"planned_hours",
"logged_hours",
"remaining_hours",
"from",
"to"
],
"num_users": 1,
"num_projects": 0,
"active_projects_count": 0,
"total_projects_count": 0,
"capacity": {
"hours": 40,
"minutes": 0,
"seconds": 0.0,
"formatted": "40:00",
"total_hours": 40.0,
"total_seconds": 144000.0,
"total_minutes": 2400.0
},
"status": "active",
"beta": false,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "control",
"days": -1
},
{
"name": "memories",
"days": -1
},
{
"name": "billing",
"days": -1
},
{
"name": "project_required_fields",
"days": -1
},
{
"name": "teams",
"days": -1
},
{
"name": "recurring_budget",
"days": -1
},
{
"name": "notifications_project_budget",
"days": -1
},
{
"name": "weekly_user_capacity",
"days": -1
},
{
"name": "company_view",
"days": -1
},
{
"name": "anomalies",
"days": -1
},
{
"name": "log_hours_for_others",
"days": -1
},
{
"name": "project_budget",
"days": -1
},
{
"name": "budgets_hourly_rates",
"days": -1
},
{
"name": "account_branding",
"days": -1
},
{
"name": "team_lead",
"days": -1
},
{
"name": "ai_timesheet_creation",
"days": -1
},
{
"name": "in_app_support",
"days": -1
},
{
"name": "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": "tasks",
"days": -1
},
{
"name": "planning",
"days": -1
},
{
"name": "batch_log_planned_time",
"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/1551/activities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer NWpKHNgqH2gW6IFbYeDEKkwzFqcobaULR4Xfd9VcVrc" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/activities
GET /1.1/1551/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer NWpKHNgqH2gW6IFbYeDEKkwzFqcobaULR4Xfd9VcVrc
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": 157,
"user": {
"id": 3784,
"email": "marijakpqqrpsx@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:17+02:00"
},
"message": "archived",
"activity_type": "archive_project",
"url": "http://app.timelyapp.local:3002/1551/projects/1478?type=archived_project",
"updated_at": "2022-06-09T15:56:17+02:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 1478,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 1133,
"name": "Modi quibusdam commodi quasi.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:17+02:00"
},
"updated_at": "2022-06-16T15:56:17+02:00"
},
"anomaly": false
},
{
"id": 156,
"user": {
"id": 3784,
"email": "marijakpqqrpsx@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/14a2a771893343f577c1c1eb9f0effdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:17+02:00"
},
"message": "50% of budget used",
"activity_type": "project_budget_progress_fifty",
"url": "http://app.timelyapp.local:3002/1551/projects/1478?type=budget_progress",
"updated_at": "2022-06-16T15:56:17+02:00",
"detail": null,
"associated_ids": [],
"entity_type": "Project",
"entity_deleted": false,
"parent_entity_name": "",
"entity": {
"id": 1478,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 1133,
"name": "Modi quibusdam commodi quasi.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:17+02:00"
},
"updated_at": "2022-06-16T15:56:17+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/1552" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer DYeZn6tGNDCW0LQKIH2S9DdE_mbSeyj7Kh3d4wS4NNA" \
-H "Cookie: "
Endpoint
GET /1.1/accounts/:id
GET /1.1/accounts/1552
Accept: application/json
Content-Type: application/json
Authorization: Bearer DYeZn6tGNDCW0LQKIH2S9DdE_mbSeyj7Kh3d4wS4NNA
Parameters
Name | Description |
---|---|
id | The id of the account to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1552,
"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": 1594,
"plan_name": "Essential",
"next_charge": "2022-07-16",
"start_of_week": 0,
"created_at": 1655387777,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"plan_code": "essential",
"plan_custom": false,
"appstore_transaction_id": null,
"owner_id": 3787,
"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,
"report_columns_order": [
"budget",
"hour_date",
"name",
"email",
"logged_hours",
"estimated_hours",
"logged_money",
"estimated_money",
"hour_labels",
"hour_billed",
"hour_note",
"hour_from",
"hour_to",
"teams",
"external_id",
"billable_hours",
"non_billable_hours",
"internal_cost",
"estimated_internal_cost",
"task_title"
],
"task_report_columns_order": [
"title",
"description",
"status",
"username",
"estimated_hours",
"planned_hours",
"logged_hours",
"remaining_hours",
"from",
"to"
],
"num_users": 1,
"num_projects": 0,
"active_projects_count": 0,
"total_projects_count": 0,
"capacity": {
"hours": 40,
"minutes": 0,
"seconds": 0.0,
"formatted": "40:00",
"total_hours": 40.0,
"total_seconds": 144000.0,
"total_minutes": 2400.0
},
"status": "active",
"beta": false,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "control",
"days": -1
},
{
"name": "memories",
"days": -1
},
{
"name": "billing",
"days": -1
},
{
"name": "project_required_fields",
"days": -1
},
{
"name": "teams",
"days": -1
},
{
"name": "recurring_budget",
"days": -1
},
{
"name": "notifications_project_budget",
"days": -1
},
{
"name": "weekly_user_capacity",
"days": -1
},
{
"name": "company_view",
"days": -1
},
{
"name": "anomalies",
"days": -1
},
{
"name": "log_hours_for_others",
"days": -1
},
{
"name": "project_budget",
"days": -1
},
{
"name": "budgets_hourly_rates",
"days": -1
},
{
"name": "account_branding",
"days": -1
},
{
"name": "team_lead",
"days": -1
},
{
"name": "ai_timesheet_creation",
"days": -1
},
{
"name": "in_app_support",
"days": -1
},
{
"name": "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": "tasks",
"days": -1
},
{
"name": "planning",
"days": -1
},
{
"name": "batch_log_planned_time",
"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/1571/clients" -d '{"name":null,"client":{"name":"Uniq name","active":true,"external_id":null}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Vez4lFRgF-TpelM8VQseppXHLnhcvWd0hKbTAH6M5q8" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/clients
POST /1.1/1571/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer Vez4lFRgF-TpelM8VQseppXHLnhcvWd0hKbTAH6M5q8
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": 1149,
"name": "Uniq name",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:23+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/1572/clients" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer FfcQrmH--nWLe0p5pWGOVW-T94hQOGQeylcTOOA1aVw" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients
GET /1.1/1572/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer FfcQrmH--nWLe0p5pWGOVW-T94hQOGQeylcTOOA1aVw
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": 1150,
"name": "Earum illo quia unde.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:23+02:00",
"external_references": []
}
]
Show client
Request
curl -g "https://api.timelyapp.com/1.1/1574/clients/1152" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer MiDMa4zil1pzQdDVA_JDbOpBaztDpylrKG6n70eP9mY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients/:id
GET /1.1/1574/clients/1152
Accept: application/json
Content-Type: application/json
Authorization: Bearer MiDMa4zil1pzQdDVA_JDbOpBaztDpylrKG6n70eP9mY
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": 1152,
"name": "Eum illo sit aut.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:24+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/1576/clients/1154" -d '{"name":null,"client":{"name":"Updated name","active":true}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer A-Nwydai-3nOfMrYATn9-Ba7NjiJgLilyqRuFUyRxAk" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/clients/:id
PUT /1.1/1576/clients/1154
Accept: application/json
Content-Type: application/json
Authorization: Bearer A-Nwydai-3nOfMrYATn9-Ba7NjiJgLilyqRuFUyRxAk
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": 1154,
"name": "Updated name",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:25+02:00"
}
Events
Events are all the entries a user makes. Users can add, delete and edit all entries. Some user’s actions are restricted based on their access level in Timely.
Create an event
When a user creates an event on their own timesheet.
Note: By default, the event is created for a user’s first active project, or the project they last logged time to.
Request
curl "https://api.timelyapp.com/1.1/1595/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:29.035+02:00","to":"2022-06-16T19:26:29.035+02:00","day":"2022-06-16","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":1505}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer o-QFLWWdeMh8GrNWEOTS8tND64yN70-opoCeRqkRG6U" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/events
POST /1.1/1595/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer o-QFLWWdeMh8GrNWEOTS8tND64yN70-opoCeRqkRG6U
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:29.035+02:00","to":"2022-06-16T19:26:29.035+02:00","day":"2022-06-16","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":1505}}
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": 1982,
"uid": "fb87582825f9d28a8d42c5e5e5e8b23d",
"user": {
"id": 3878,
"email": "marijafbkibslk@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/2c557bb631f09a36470bd19f09be7c2d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/2c557bb631f09a36470bd19f09be7c2d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/2c557bb631f09a36470bd19f09be7c2d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/2c557bb631f09a36470bd19f09be7c2d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/2c557bb631f09a36470bd19f09be7c2d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:28+02:00"
},
"project": {
"id": 1505,
"active": true,
"account_id": 1595,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387789,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1161,
"name": "Et voluptas qui minima.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:29+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"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": 1655387789,
"created_at": 1655387789,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:29+02:00",
"from": "2022-06-16T15:56:29+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 3878,
"updater_id": 3878,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Create an event for a project
Request
curl "https://api.timelyapp.com/1.1/1594/projects/1504/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:28.638+02:00","to":"2022-06-16T19:26:28.638+02:00","day":"2022-06-16","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":1504}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer MrZA92ngcL4lbZ_Tf_ueVYT7cRw9ngm6sr6AhS_A7vw" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects/:project_id/events
POST /1.1/1594/projects/1504/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer MrZA92ngcL4lbZ_Tf_ueVYT7cRw9ngm6sr6AhS_A7vw
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:28.638+02:00","to":"2022-06-16T19:26:28.638+02:00","day":"2022-06-16","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":1504}}
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": 1981,
"uid": "b3b4d2dbedc99fe843fd3dedb02f086f",
"user": {
"id": 3876,
"email": "marijaekzlviwq@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/ea23a084c7e2976553312296d01a28b6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/ea23a084c7e2976553312296d01a28b6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ea23a084c7e2976553312296d01a28b6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ea23a084c7e2976553312296d01a28b6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/ea23a084c7e2976553312296d01a28b6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:28+02:00"
},
"project": {
"id": 1504,
"active": true,
"account_id": 1594,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387788,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1160,
"name": "Est velit suscipit a.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:28+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"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": 1655387788,
"created_at": 1655387788,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:28+02:00",
"from": "2022-06-16T15:56:28+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 3876,
"updater_id": 3876,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Create an event for another user
Note: Normal users can add hours for any user. If a project_id is not provided, the event is created against a user’s first active project, or the project they logged an event to in the last hour.
Request
curl "https://api.timelyapp.com/1.1/1593/users/3874/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:28.297+02:00","to":"2022-06-16T19:26:28.297+02:00","day":"2022-06-16","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":3874}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer _mTElM4ILrLJA3878hfSFPeqQA9PfonVu_xD8js_54Q" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users/:user_id/events
POST /1.1/1593/users/3874/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer _mTElM4ILrLJA3878hfSFPeqQA9PfonVu_xD8js_54Q
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:28.297+02:00","to":"2022-06-16T19:26:28.297+02:00","day":"2022-06-16","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":3874}}
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": 1980,
"uid": "f80bf05527157a8c2a7bb63b22f49aaa",
"user": {
"id": 3874,
"email": "marijaebejvnby@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/1dbe523b323c8d2758a578dca243e074?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/1dbe523b323c8d2758a578dca243e074?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/1dbe523b323c8d2758a578dca243e074?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/1dbe523b323c8d2758a578dca243e074?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/1dbe523b323c8d2758a578dca243e074?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:28+02:00"
},
"project": {
"id": 1503,
"active": true,
"account_id": 1593,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387788,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1159,
"name": "Repudiandae consequatur quis ratione.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:28+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"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": 1655387788,
"created_at": 1655387788,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:28+02:00",
"from": "2022-06-16T15:56:28+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": 3874,
"updater_id": 3874,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Create bulk events
Note: Use the same list of sub-parameters inside your "create" parameter as specified on Create an event. You can create up to 100 events at a time.
Request
curl "https://api.timelyapp.com/1.1/1592/bulk/events" -d '{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:27.870+02:00","to":"2022-06-16T19:26:27.870+02:00","day":"2022-06-16","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":3872,"account_id":1592,"project_id":1502}]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer M6BWoO2PvhzxGTZhhFQACyemc5X7G6b9suyxmSLaPqA" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/1592/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer M6BWoO2PvhzxGTZhhFQACyemc5X7G6b9suyxmSLaPqA
Parameters
{"create":[{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2022-06-16T15:56:27.870+02:00","to":"2022-06-16T19:26:27.870+02:00","day":"2022-06-16","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":3872,"account_id":1592,"project_id":1502}]}
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": [
1979
],
"updated_ids": [],
"errors": {
"create": [],
"update": [],
"delete": []
}
}
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/1597/events/1984" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ulhFMrt9f-f_I5stH0rcmlRYq8cH43nOTo4tCjXd2n4" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/events/:id
DELETE /1.1/1597/events/1984
Accept: application/json
Content-Type: application/json
Authorization: Bearer ulhFMrt9f-f_I5stH0rcmlRYq8cH43nOTo4tCjXd2n4
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/1596/bulk/events" -d '{"delete":[1983]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 7iIBAamRIV0vCEVpo9D3fJqwllKMhj99Y0T-Ilv8ihA" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/1596/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7iIBAamRIV0vCEVpo9D3fJqwllKMhj99Y0T-Ilv8ihA
Parameters
{"delete":[1983]}
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": [
1983
],
"created_ids": [],
"updated_ids": [],
"errors": {
"create": [],
"update": [],
"delete": []
}
}
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/1602/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer J84RsGl58ybOu3_1_ypKy0ybcvakAsWFQvVGJ-mPxzQ" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events
GET /1.1/1602/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer J84RsGl58ybOu3_1_ypKy0ybcvakAsWFQvVGJ-mPxzQ
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": 1989,
"uid": "4a3e00961a08879c34f91ca0070ea2f5",
"user": {
"id": 3892,
"email": "marijagkbcsdku@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/013e3a315d05a1c8571ef5f61e17fbdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/013e3a315d05a1c8571ef5f61e17fbdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/013e3a315d05a1c8571ef5f61e17fbdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/013e3a315d05a1c8571ef5f61e17fbdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/013e3a315d05a1c8571ef5f61e17fbdd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:31+02:00"
},
"project": {
"id": 1512,
"active": true,
"account_id": 1602,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387791,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1168,
"name": "Aut dolore et quia.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:31+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"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": 1655387791,
"created_at": 1655387791,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:31+02:00",
"from": "2022-06-16T15:56:31+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,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
]
List all events for a project
Note: Normal users can access events logged to all projects on an account. Limited users can only access events in projects they belong to.
Request
curl -g "https://api.timelyapp.com/1.1/1605/projects/1515/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 4T52YTbwSuyPRsKzC0yfWlZo9T230MtKvfFdnNCmrGc" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:project_id/events
GET /1.1/1605/projects/1515/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4T52YTbwSuyPRsKzC0yfWlZo9T230MtKvfFdnNCmrGc
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": 1992,
"uid": "d5c186983b52c4551ee00f72316c6eaa",
"user": {
"id": 3898,
"email": "marijakslgtczd@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/6ac606b16e29eb4b39f0480cd0bc812d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/6ac606b16e29eb4b39f0480cd0bc812d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/6ac606b16e29eb4b39f0480cd0bc812d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/6ac606b16e29eb4b39f0480cd0bc812d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/6ac606b16e29eb4b39f0480cd0bc812d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:32+02:00"
},
"project": {
"id": 1515,
"active": true,
"account_id": 1605,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387793,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1171,
"name": "Id nisi cupiditate optio.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:33+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"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": 1655387793,
"created_at": 1655387793,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:33+02:00",
"from": "2022-06-16T15:56:33+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,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
]
List all events for a user
Note: Normal users can access events logged by other users on an account. Limited users can only access their own logged events.
Request
curl -g "https://api.timelyapp.com/1.1/1604/users/3896/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer hqPOd1jyVERrYXUVvULXIe1dAuKwhIYu-N4aNlCkAVw" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/events
GET /1.1/1604/users/3896/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer hqPOd1jyVERrYXUVvULXIe1dAuKwhIYu-N4aNlCkAVw
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": 1991,
"uid": "96055f5b06bf9381ac43879351642cf5",
"user": {
"id": 3896,
"email": "marijakomkwbog@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/e717bbe0b6e7297d514beff7c3812be8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/e717bbe0b6e7297d514beff7c3812be8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/e717bbe0b6e7297d514beff7c3812be8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/e717bbe0b6e7297d514beff7c3812be8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/e717bbe0b6e7297d514beff7c3812be8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:32+02:00"
},
"project": {
"id": 1514,
"active": true,
"account_id": 1604,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387792,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1170,
"name": "Ut nisi repellat neque.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:32+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"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": 1655387792,
"created_at": 1655387792,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:32+02:00",
"from": "2022-06-16T15:56:32+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,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
]
Logged in user updating details and user of an event
Request
curl "https://api.timelyapp.com/1.1/1613/users/3914/events/2000" -d '{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer cw2nEv10AK5X9BjKaRyCGNAUJ27z5TSaqmt6RiaN7h0" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:user_id/events/:id
PUT /1.1/1613/users/3914/events/2000
Accept: application/json
Content-Type: application/json
Authorization: Bearer cw2nEv10AK5X9BjKaRyCGNAUJ27z5TSaqmt6RiaN7h0
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": 2000,
"uid": "08f90c1a417155361a5c4b8d297e0d78",
"user": {
"id": 3914,
"email": "marijaapcfgmcn@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/45423d04cea6f755e456708f4f62108f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/45423d04cea6f755e456708f4f62108f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/45423d04cea6f755e456708f4f62108f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/45423d04cea6f755e456708f4f62108f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/45423d04cea6f755e456708f4f62108f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:36+02:00"
},
"project": {
"id": 1523,
"active": true,
"account_id": 1613,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387796,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1179,
"name": "Ea dolores amet illum.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:36+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2022-06-16",
"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": 1655387796,
"created_at": 1655387796,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:36+02:00",
"from": "2022-06-16T15:56:36+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 3914,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Loggedin user updating details and project of their event
Request
curl "https://api.timelyapp.com/1.1/1612/projects/1522/events/1999" -d '{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer uCUMhU4PVkQ3w-wI4NL_y61ZBxh2cjRD8cI3tfw8RL8" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:project_id/events/:id
PUT /1.1/1612/projects/1522/events/1999
Accept: application/json
Content-Type: application/json
Authorization: Bearer uCUMhU4PVkQ3w-wI4NL_y61ZBxh2cjRD8cI3tfw8RL8
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": 1999,
"uid": "5ec829debe54b19a5f78d9a65b900a39",
"user": {
"id": 3912,
"email": "marijabrlavwwj@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/e19df5c56e7a9f6b2324a4065699d08b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/e19df5c56e7a9f6b2324a4065699d08b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/e19df5c56e7a9f6b2324a4065699d08b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/e19df5c56e7a9f6b2324a4065699d08b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/e19df5c56e7a9f6b2324a4065699d08b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:35+02:00"
},
"project": {
"id": 1522,
"active": true,
"account_id": 1612,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387796,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1178,
"name": "Tempore beatae doloremque dolore.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:36+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2022-06-16",
"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": 1655387796,
"created_at": 1655387796,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:36+02:00",
"from": "2022-06-16T15:56:36+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 3912,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Retrieve an event
Request
curl -g "https://api.timelyapp.com/1.1/1600/events/1987" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer o6gQ--qUIHiCgvNHcqC4BDdJU7vP8sZfGCmudv-jYHM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events/:id
GET /1.1/1600/events/1987
Accept: application/json
Content-Type: application/json
Authorization: Bearer o6gQ--qUIHiCgvNHcqC4BDdJU7vP8sZfGCmudv-jYHM
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": 1987,
"uid": "d68a18275455ae3eaa2c291eebb46e6d",
"user": {
"id": 3888,
"email": "marijaietaegoe@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/4a1c131e4965d3f1671b4ddc5caa28ab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/4a1c131e4965d3f1671b4ddc5caa28ab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/4a1c131e4965d3f1671b4ddc5caa28ab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/4a1c131e4965d3f1671b4ddc5caa28ab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/4a1c131e4965d3f1671b4ddc5caa28ab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:30+02:00"
},
"project": {
"id": 1510,
"active": true,
"account_id": 1600,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387791,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1166,
"name": "Explicabo officia error qui.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:31+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"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": 1655387791,
"created_at": 1655387791,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:31+02:00",
"from": "2022-06-16T15:56:31+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,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Start timer on an event
Request
curl "https://api.timelyapp.com/1.1/1606/events/1993/start" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer qYC05cMN_cePD7cnUNgNLTcklbPdaeTx9R120QPuEhg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/start
PUT /1.1/1606/events/1993/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer qYC05cMN_cePD7cnUNgNLTcklbPdaeTx9R120QPuEhg
Parameters
Name | Description |
---|---|
id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1993,
"uid": "c5a4e7e6882845ea7bb4d9462868219b",
"user": {
"id": 3900,
"email": "marijaojrencri@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/c17f94576e5bb06056f2cbcac8b99819?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/c17f94576e5bb06056f2cbcac8b99819?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/c17f94576e5bb06056f2cbcac8b99819?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/c17f94576e5bb06056f2cbcac8b99819?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/c17f94576e5bb06056f2cbcac8b99819?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:33+02:00"
},
"project": {
"id": 1516,
"active": true,
"account_id": 1606,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387793,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1172,
"name": "Exercitationem et odit molestiae.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:33+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "start",
"timer_started_on": 1655387793,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1655387793,
"created_at": 1655387793,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:33+02:00",
"from": "2022-06-16T15:56:33+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 3900,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Stop timer on an event
Request
curl "https://api.timelyapp.com/1.1/1607/events/1994/stop" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer mADzo_QSNfiv_hugd2_6ztYddXMGerx2JiOE7XAWHmc" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/stop
PUT /1.1/1607/events/1994/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer mADzo_QSNfiv_hugd2_6ztYddXMGerx2JiOE7XAWHmc
Parameters
Name | Description |
---|---|
id required | Event ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1994,
"uid": "008bd5ad93b754d500338c253d9c1770",
"user": {
"id": 3902,
"email": "marijaliuabvrq@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/36653fabecf72eb41fdf4b8db2c5e2be?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/36653fabecf72eb41fdf4b8db2c5e2be?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/36653fabecf72eb41fdf4b8db2c5e2be?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/36653fabecf72eb41fdf4b8db2c5e2be?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/36653fabecf72eb41fdf4b8db2c5e2be?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:33+02:00"
},
"project": {
"id": 1517,
"active": true,
"account_id": 1607,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387794,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1173,
"name": "Dolore excepturi omnis assumenda.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:34+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"day": "2022-06-16",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "stop",
"timer_started_on": 0,
"timer_stopped_on": 1655387794,
"label_ids": [],
"user_ids": [],
"updated_at": 1655387794,
"created_at": 1655387794,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:34+02:00",
"from": "2022-06-16T15:56:34+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 3902,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Update an event
Request
curl "https://api.timelyapp.com/1.1/1611/events/1998" -d '{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer oSk66VdguAQDM4T7qDXOY0_-rFtvDi_0UjFu29h49SQ" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id
PUT /1.1/1611/events/1998
Accept: application/json
Content-Type: application/json
Authorization: Bearer oSk66VdguAQDM4T7qDXOY0_-rFtvDi_0UjFu29h49SQ
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": 1998,
"uid": "c5b2cebf15b205503560c4e8e6d1ea78",
"user": {
"id": 3910,
"email": "marijabxncqxnt@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/e2ea47c3adcca6dbad9577f79779171c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/e2ea47c3adcca6dbad9577f79779171c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/e2ea47c3adcca6dbad9577f79779171c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/e2ea47c3adcca6dbad9577f79779171c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/e2ea47c3adcca6dbad9577f79779171c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:35+02:00"
},
"project": {
"id": 1521,
"active": true,
"account_id": 1611,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387795,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1177,
"name": "Deserunt aut debitis in.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:35+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": []
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2022-06-16",
"note": "Updated notes",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [],
"user_ids": [],
"updated_at": 1655387795,
"created_at": 1655387795,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"billable": true,
"to": "2022-06-16T19:26:35+02:00",
"from": "2022-06-16T15:56:35+02:00",
"deleted": false,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000,
"creator_id": null,
"updater_id": 3910,
"external_id": null,
"entry_ids": [],
"suggestion_id": null,
"draft": false,
"manage": true,
"forecast_id": null,
"billed_at": null,
"locked_reason": null,
"locked": false,
"invoice_id": null,
"timestamps": []
}
Update bulk events
Note: Use the same list of sub-parameters inside your "update" parameter as specified on Update an event. You can update up to 100 events at a time.
Request
curl "https://api.timelyapp.com/1.1/1608/bulk/events" -d '{"update":[{"id":1995,"note":"updated","billed":true}]}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6tmutSnJlMKgVcR-pmiT2VURnghWDiJBO50-9JSenVk" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/bulk/events
POST /1.1/1608/bulk/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6tmutSnJlMKgVcR-pmiT2VURnghWDiJBO50-9JSenVk
Parameters
{"update":[{"id":1995,"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": [
1995
],
"errors": {
"create": [],
"update": [],
"delete": []
}
}
Forecasts (beta)
Forecasts (currently in beta) 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. Contact support at support@timelyapp.com to request access.
Create a forecast
Request
curl "https://api.timelyapp.com/1.1/1645/forecasts" -d '{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":150,"users":[{"id":3977}],"project_id":1538,"title":"Title"}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer N7xgkc02gDzvQha7WpYJYID4IQYnOuIpsGhzfsRQ0Cw" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/forecasts
POST /1.1/1645/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer N7xgkc02gDzvQha7WpYJYID4IQYnOuIpsGhzfsRQ0Cw
Parameters
{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":150,"users":[{"id":3977}],"project_id":1538,"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] |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 257,
"note": "Title",
"title": "Title",
"description": "",
"from": "2022-05-10",
"to": "2022-05-16",
"user": {
"id": 3977,
"email": "marijazgsanjvs@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:39+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": 3977,
"email": "marijazgsanjvs@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/2f42190ee850c52fd760b2c65d94e293?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:39+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": 1538,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 1202,
"name": "Quia quae et et.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:40+02:00"
},
"updated_at": "2022-06-16T15:56:40+02:00"
},
"estimated_minutes": 150,
"updated_at": "2022-06-16T15:56:40+02:00",
"created_at": "2022-06-16T15:56:40+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
}
Delete a forecast
Request
curl "https://api.timelyapp.com/1.1/1646/forecasts/258" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer aDFGu0Sq9GUhuUwwf1EjVMKmautYZLfW1va6ZAI3OUM" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/forecasts/:id
DELETE /1.1/1646/forecasts/258
Accept: application/json
Content-Type: application/json
Authorization: Bearer aDFGu0Sq9GUhuUwwf1EjVMKmautYZLfW1va6ZAI3OUM
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/1647/forecasts" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 15eWiS76S4Muvul4q93dh4EqFAdK8pRCDTCOT-dx6ss" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/forecasts
GET /1.1/1647/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer 15eWiS76S4Muvul4q93dh4EqFAdK8pRCDTCOT-dx6ss
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": 259,
"note": "title",
"title": "title",
"description": null,
"from": "2022-06-13",
"to": "2022-06-19",
"user": {
"id": 3984,
"email": "quentinafkebgli@timelyapp.com",
"name": "Quintin Duponde",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/33f4576dc2020d41426ecffe3e587ad9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/33f4576dc2020d41426ecffe3e587ad9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/33f4576dc2020d41426ecffe3e587ad9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/33f4576dc2020d41426ecffe3e587ad9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/33f4576dc2020d41426ecffe3e587ad9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:40+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": 3982,
"email": "marijacendyrzk@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/44fc736b36758d4c2f1a1db5df995678?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/44fc736b36758d4c2f1a1db5df995678?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/44fc736b36758d4c2f1a1db5df995678?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/44fc736b36758d4c2f1a1db5df995678?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/44fc736b36758d4c2f1a1db5df995678?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:40+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": 1540,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 1204,
"name": "Animi incidunt ex corrupti.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:40+02:00"
},
"updated_at": "2022-06-16T15:56:40+02:00"
},
"estimated_minutes": 360,
"updated_at": "2022-06-16T15:56:40+02:00",
"created_at": "2022-06-16T15:56:40+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
}
]
Update a forecast
Request
curl "https://api.timelyapp.com/1.1/1648/forecasts/260" -d '{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":30,"users":[{"id":3985}],"project_id":1541,"title":"new title"}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 9oGWf6cFVTWf-uPd4sjeHwDTVMmoMA8azwNAGaNVRGM" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/forecasts/:id
PUT /1.1/1648/forecasts/260
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9oGWf6cFVTWf-uPd4sjeHwDTVMmoMA8azwNAGaNVRGM
Parameters
{"forecast":{"from":"2022-05-10","to":"2022-05-16","estimated_minutes":30,"users":[{"id":3985}],"project_id":1541,"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] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 260,
"note": "new title",
"title": "new title",
"description": "",
"from": "2022-05-10",
"to": "2022-05-16",
"user": {
"id": 3985,
"email": "marijaemvidegh@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:41+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": 3985,
"email": "marijaemvidegh@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/1e85f6e9aae4328bac7286f525d03fda?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"updated_at": "2022-06-16T15:56:41+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": 1541,
"active": true,
"name": "Timely",
"color": "67a3bc",
"client": {
"id": 1205,
"name": "Ipsa odio amet est.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:41+02:00"
},
"updated_at": "2022-06-16T15:56:41+02:00"
},
"estimated_minutes": 30,
"updated_at": "2022-06-16T15:56:41+02:00",
"created_at": "2022-06-16T15:56:41+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
}
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/1686/labels" -d '{"name":null,"label":{"name":"Web Programming","active":true}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer NaAIG_7TH31yokouLWjX4ikXVL3xaUJsjUM-RJROUEc" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/labels
POST /1.1/1686/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer NaAIG_7TH31yokouLWjX4ikXVL3xaUJsjUM-RJROUEc
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": 167,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7-fe0f.png",
"active": true,
"children": []
}
Delete a label
Request
curl "https://api.timelyapp.com/1.1/1687/labels/168" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer -f_KW_X-rwSNASDI8MPlE-UaRsxMWooYitsYyQA8oq8" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/labels/:id
DELETE /1.1/1687/labels/168
Accept: application/json
Content-Type: application/json
Authorization: Bearer -f_KW_X-rwSNASDI8MPlE-UaRsxMWooYitsYyQA8oq8
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/1690/labels?parent_id=170" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 8gzl3nDU_qrKMVKl0gwggpAYMNZq-p30Rtf6TlHN0Hw" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/1690/labels?parent_id=170
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8gzl3nDU_qrKMVKl0gwggpAYMNZq-p30Rtf6TlHN0Hw
Parameters
parent_id: 170
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": 170,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"active": true,
"children": []
}
List all labels
Get all the tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/1689/labels" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TYmyDfp0vjPgWR7lqIXyyKn8jFnPT41hi1TT1_8qQSs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/1689/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer TYmyDfp0vjPgWR7lqIXyyKn8jFnPT41hi1TT1_8qQSs
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/1688/labels/169" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer r4m3Vqov2koDGYaOQ-XzLJvphstoMQkl4S-75CKoJOY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels/:id
GET /1.1/1688/labels/169
Accept: application/json
Content-Type: application/json
Authorization: Bearer r4m3Vqov2koDGYaOQ-XzLJvphstoMQkl4S-75CKoJOY
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": 169,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"active": true,
"children": []
}
Update a label
Request
curl "https://api.timelyapp.com/1.1/1691/labels/171" -d '{"name":null,"label":{"name":"updated name"}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer CTq_o2S70Lq9ugUxE4GXwBQIrDR6j_-_uaFB0AwQyNI" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/labels/:id
PUT /1.1/1691/labels/171
Accept: application/json
Content-Type: application/json
Authorization: Bearer CTq_o2S70Lq9ugUxE4GXwBQIrDR6j_-_uaFB0AwQyNI
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": 171,
"name": "updated name",
"sequence": 1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7-fe0f.png",
"active": true,
"children": []
}
Permissions
Retrieve current user's permissions
Using the account id one can see the currently logged user's permissions
Request
curl -g "https://api.timelyapp.com/1.1/1702/users/current/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer xG0GbDitDKWpvlp_om-qKbmc1osaaNVEs-4VfP2beLA" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current/permissions
GET /1.1/1702/users/current/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer xG0GbDitDKWpvlp_om-qKbmc1osaaNVEs-4VfP2beLA
Parameters
Name | Description |
---|---|
account_id | Account id for which current user's permissions are to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"resource": "user",
"permissions": [
"create",
"read",
"update",
"delete",
"notify"
]
},
{
"resource": "project",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "label",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "company",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "team",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "account",
"permissions": [
"create",
"read",
"update",
"manage_plan",
"manage_subscriptions",
"manage_dev"
]
},
{
"resource": "report",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "forecast",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "invoice",
"permissions": [
"create",
"read",
"update",
"delete"
]
}
]
Retrieve user's permissions by id
Using the account id and user id one can see a specific user's permissions
Request
curl -g "https://api.timelyapp.com/1.1/1703/users/4093/permissions" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer iVhwcn9HT6izg2XxyZMDHGuwkJF6M8BNIaLTMlZbtE8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/permissions
GET /1.1/1703/users/4093/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer iVhwcn9HT6izg2XxyZMDHGuwkJF6M8BNIaLTMlZbtE8
Parameters
Name | Description |
---|---|
account_id | Account for which user's permissions are required |
user_id | User whose permissions are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"resource": "user",
"permissions": [
"create",
"read",
"update",
"delete",
"notify"
]
},
{
"resource": "project",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "label",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "company",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "team",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "account",
"permissions": [
"create",
"read",
"update",
"manage_plan",
"manage_subscriptions",
"manage_dev"
]
},
{
"resource": "report",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "forecast",
"permissions": [
"create",
"read",
"update",
"delete"
]
},
{
"resource": "invoice",
"permissions": [
"create",
"read",
"update",
"delete"
]
}
]
Projects
Projects contain all the project details on an account. With this API, you can retrieve, update, create or delete a specific project, or list all projects.
Create a project
Request
curl "https://api.timelyapp.com/1.1/1709/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,"client_id":1248,"budget_type":"M","budget":300,"users":[{"user_id":4105}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":172,"required":true},{"label_id":173,"required":true},{"label_id":174,"required":false},{"label_id":175,"required":false}]},"name":null}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer IhCXdhTU7EXxypSqzCRf8DETmC17pVwFlPnL-zf0t_o" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects
POST /1.1/1709/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer IhCXdhTU7EXxypSqzCRf8DETmC17pVwFlPnL-zf0t_o
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,"client_id":1248,"budget_type":"M","budget":300,"users":[{"user_id":4105}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":172,"required":true},{"label_id":173,"required":true},{"label_id":174,"required":false},{"label_id":175,"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": 1574,
"active": true,
"account_id": 1709,
"name": "New Project",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387812,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1248,
"name": "Ut a suscipit sequi.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:52+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": true,
"enable_labels": "all",
"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": 4105,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2022-06-16T15:56:52+02:00",
"created_at": "2022-06-16T15:56:52+02:00",
"deleted": false
}
],
"labels": [
{
"project_id": 1574,
"label_id": 172,
"budget": 0,
"required": true,
"updated_at": "2022-06-16T20:56:52+07:00"
},
{
"project_id": 1574,
"label_id": 173,
"budget": 0,
"required": true,
"updated_at": "2022-06-16T20:56:52+07:00"
},
{
"project_id": 1574,
"label_id": 174,
"budget": 0,
"required": false,
"updated_at": "2022-06-16T20:56:52+07:00"
},
{
"project_id": 1574,
"label_id": 175,
"budget": 0,
"required": false,
"updated_at": "2022-06-16T20:56:52+07:00"
}
],
"label_ids": [
172,
173,
174,
175
],
"required_label_ids": [
172,
173
],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"first_logged_on": null,
"last_logged_on": null,
"budget_recurrence": {
"recur": "week",
"start_date": "2018-09-21",
"end_date": "2019-09-21",
"recur_until": "end_date",
"days_count": 365,
"updated_at": "2022-06-16T15:56:52+02:00"
}
}
Delete a project
Request
curl "https://api.timelyapp.com/1.1/1710/projects/1575" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer z6mDNqrjYqGPXq9096_kwnGT4RuICqtKZCrbyLCVS9M" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/projects/:id
DELETE /1.1/1710/projects/1575
Accept: application/json
Content-Type: application/json
Authorization: Bearer z6mDNqrjYqGPXq9096_kwnGT4RuICqtKZCrbyLCVS9M
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/1712/projects" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer suqQ4Xx7PfYOkadUFoqCy9sN63IxOtbuVRE7yFSnUjQ" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects
GET /1.1/1712/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer suqQ4Xx7PfYOkadUFoqCy9sN63IxOtbuVRE7yFSnUjQ
Parameters
Name | Description |
---|---|
offset | Retrieve projects from offset |
limit | Retrieve number of projects |
sort | Field to sort projects by (Default updated_at) |
order | Sorting order (Default desc) |
filter | Filter projects - mine, active, archived, all (Default mine) |
updated_after | Retrieve records updated after a certain timestamp |
project_ids | Retrieve specific projects |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 1577,
"active": true,
"account_id": 1712,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387814,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1251,
"name": "Qui nostrum recusandae natus.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:54+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": 4111,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2022-06-16T15:56:54+02:00",
"created_at": "2022-06-16T15:56:54+02:00",
"deleted": false
}
],
"labels": [],
"label_ids": [],
"required_label_ids": [],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
}
}
]
Retrieve a project
Retrieve a single project by using its ID.
Request
curl -g "https://api.timelyapp.com/1.1/1711/projects/1576" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer nv1aN7o6SfFXXfw1qVt0YX99GD6jB2ZPWgc5T7I34WQ" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:id
GET /1.1/1711/projects/1576
Accept: application/json
Content-Type: application/json
Authorization: Bearer nv1aN7o6SfFXXfw1qVt0YX99GD6jB2ZPWgc5T7I34WQ
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": 1576,
"active": true,
"account_id": 1711,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387813,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1250,
"name": "Sequi eligendi reprehenderit laboriosam.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:53+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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": 4109,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2022-06-16T15:56:53+02:00",
"created_at": "2022-06-16T15:56:53+02:00",
"deleted": false
}
],
"labels": [],
"label_ids": [],
"required_label_ids": [],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"first_logged_on": null,
"last_logged_on": null
}
Update a project
Request
curl "https://api.timelyapp.com/1.1/1714/projects/1579" -d '{"project":{"name":"updated project name","name":null}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer QYkyHbdkf4gN1lwt236698xR0u-qKxhM-FDpt-9j7ug" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:id
PUT /1.1/1714/projects/1579
Accept: application/json
Content-Type: application/json
Authorization: Bearer QYkyHbdkf4gN1lwt236698xR0u-qKxhM-FDpt-9j7ug
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": 1579,
"active": true,
"account_id": 1714,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387815,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1253,
"name": "Rem dolore aut tempore.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:56:55+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "none",
"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": 4115,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2022-06-16T15:56:55+02:00",
"created_at": "2022-06-16T15:56:55+02:00",
"deleted": false
}
],
"labels": [],
"label_ids": [],
"required_label_ids": [],
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"first_logged_on": null,
"last_logged_on": null
}
Reports
Report on activity across your business, including individual and team performance. Export report data from JSON to a format of your choice. Note: .XLS, .CSV and .PDF report formats can only be downloaded from the web UI, not the API.
All Reports
For a normal user accessing all account reports.
Note:
1) If start_date and end_date parameters are not passed, the period will default to the beginning-to-end of a month. 2) If user and project parameters are not passed, by default a normal user will get all reports on an account, and a limited user will only get reports they have created. 3) Only normal users can access reports created by other users on an account. Limited users can only access reports they have created. 4) Only normal users can access reports for other projects on an account. Limited users can only access reports for projects they have created.
Request
curl "https://api.timelyapp.com/1.1/1750/reports" -d '{"user_ids":"4220","since":"2018-01-01","until":"2019-01-01","project_ids":"1664"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 4ybIo1g-wy1XnzaXMkGUsPOr-LyBYuCaVwR66vWbWJU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports
POST /1.1/1750/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4ybIo1g-wy1XnzaXMkGUsPOr-LyBYuCaVwR66vWbWJU
Parameters
{"user_ids":"4220","since":"2018-01-01","until":"2019-01-01","project_ids":"1664"}
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": 1289,
"name": "Voluptas libero corrupti nam.",
"projects": [
{
"id": 1664,
"active": true,
"account_id": 1750,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387832,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1289,
"name": "Voluptas libero corrupti nam.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:57:12+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
}
],
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
}
]
Filter reports
Use filter endpoints with parameters to limit returned data, so you only see the values that you need.
Request
curl "https://api.timelyapp.com/1.1/1751/reports/filter" -d '{"user_ids":"4222","since":"2018-01-01","until":"2019-01-01","project_ids":"1665"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer __or-5QmRz-G5LKRbgOYdyD_OgGzh4DIUFwlDrA7bn8" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports/filter
POST /1.1/1751/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer __or-5QmRz-G5LKRbgOYdyD_OgGzh4DIUFwlDrA7bn8
Parameters
{"user_ids":"4222","since":"2018-01-01","until":"2019-01-01","project_ids":"1665"}
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
{
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
},
"clients": [
{
"id": 1290,
"name": "Molestiae et rerum aut.",
"projects": [
{
"id": 1665,
"active": true,
"account_id": 1751,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1655387832,
"external_id": null,
"budget_scope": null,
"client": {
"id": 1290,
"name": "Molestiae et rerum aut.",
"active": true,
"external_id": null,
"updated_at": "2022-06-16T15:57:12+02:00"
},
"required_notes": false,
"required_labels": false,
"budget_expired_on": null,
"has_recurrence": false,
"enable_labels": "all",
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
}
],
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
}
],
"users": [
{
"id": 4222,
"email": "marijavouupuru@timelyapp.com",
"name": "Marija Petrovic",
"time_zone": "Europe/Paris",
"updated_at": 1655387832,
"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,
"accounts_waiting_acknowledgement": [
{
"account_id": 1751,
"account_sitename": "Timely",
"memory_retention_days": 0
}
],
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/a57c28253c3b23cbed690db4da1ca109?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/a57c28253c3b23cbed690db4da1ca109?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/a57c28253c3b23cbed690db4da1ca109?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/a57c28253c3b23cbed690db4da1ca109?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/a57c28253c3b23cbed690db4da1ca109?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
},
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
}
],
"labels": [
{
"id": 0,
"name": "Untagged",
"sequence": -1,
"parent_id": null,
"emoji": "https://emoji.memorycdn.com/tw64/1f3f7.png",
"active": true,
"children": [],
"duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"estimated_duration": {
"hours": 8,
"minutes": 0,
"seconds": 0,
"formatted": "08:00",
"total_hours": 8.0,
"total_seconds": 28800,
"total_minutes": 480
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 5,
"minutes": 0,
"seconds": 0,
"formatted": "05:00",
"total_hours": 5.0,
"total_seconds": 18000,
"total_minutes": 300
},
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
}
],
"days": [
{
"day": "2018-01-02",
"duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"billed_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"unbilled_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"billable_duration": {
"hours": 2,
"minutes": 30,
"seconds": 0,
"formatted": "02:30",
"total_hours": 2.5,
"total_seconds": 9000,
"total_minutes": 150
},
"non_billable_duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
}
},
{
"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
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
}
}
],
"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
},
"estimated_cost": {
"fractional": 80000,
"formatted": "$800.00",
"amount": 800.0
},
"billed_cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"unbilled_cost": {
"fractional": 50000,
"formatted": "$500.00",
"amount": 500.0
}
}
]
}
Roles
List roles
Note: default attribute shows which role to select by default
Request
curl -g "https://api.timelyapp.com/1.1/1752/roles" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Weab0Q02PYiCoyHoVeCnRC8n84XuHbiusE49OBtkYwc" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/roles
GET /1.1/1752/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer Weab0Q02PYiCoyHoVeCnRC8n84XuHbiusE49OBtkYwc
Parameters
Name | Description |
---|---|
account_id | Account id for which roles are required |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 5254,
"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
},
{
"id": 5256,
"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
},
{
"id": 5255,
"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
}
]
Teams
The team object shows all teams available on an account.
Create a team
Request
curl "https://api.timelyapp.com/1.1/1774/teams" -d '{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":4268,"lead":true},{"user_id":4270,"lead":false}]}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer k_HdTGUjfAUTahBGfaZrVPeQaUnfMijBn2fJLxN1rZE" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/teams
POST /1.1/1774/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer k_HdTGUjfAUTahBGfaZrVPeQaUnfMijBn2fJLxN1rZE
Parameters
{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":4268,"lead":true},{"user_id":4270,"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": 34,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
4268,
4270
],
"users": [
{
"id": 163,
"user_id": 4268,
"team_id": 34,
"lead": true
},
{
"id": 164,
"user_id": 4270,
"team_id": 34,
"lead": false
}
]
}
Delete a team
Request
curl "https://api.timelyapp.com/1.1/1775/teams/35" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer TB3_uueiKA5NleBaSKJtzDHq3rNldldrt0Co7VRawPk" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/teams/:id
DELETE /1.1/1775/teams/35
Accept: application/json
Content-Type: application/json
Authorization: Bearer TB3_uueiKA5NleBaSKJtzDHq3rNldldrt0Co7VRawPk
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/1777/teams" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer UwOm-7eeSjUdvD_tn-U-dKWikqxUnM-ZrCBI_lR36Ok" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams
GET /1.1/1777/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer UwOm-7eeSjUdvD_tn-U-dKWikqxUnM-ZrCBI_lR36Ok
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": 37,
"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/1776/teams/36" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer CRLY2fJ2PglE2jbMGhczJ5Cqpp3uNAGCB-wgHADjCi8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams/:id
GET /1.1/1776/teams/36
Accept: application/json
Content-Type: application/json
Authorization: Bearer CRLY2fJ2PglE2jbMGhczJ5Cqpp3uNAGCB-wgHADjCi8
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": 36,
"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/1778/teams/38" -d '{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":4277,"lead":true}]}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer r2XF8EOrLV2B88j7sKP-0lx0r68cvOvj1eQ1hMPX9VM" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/teams/:id
PUT /1.1/1778/teams/38
Accept: application/json
Content-Type: application/json
Authorization: Bearer r2XF8EOrLV2B88j7sKP-0lx0r68cvOvj1eQ1hMPX9VM
Parameters
{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":4277,"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": 38,
"name": "Backend",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
4277
],
"users": [
{
"id": 165,
"user_id": 4277,
"team_id": 38,
"lead": true
}
]
}
UserCapacities
Retrieve capacities
See capacities of multiple users in the account
Request
curl -g "https://api.timelyapp.com/1.1/1783/users/capacities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ZRatuWfmE0_OS1gAPS77gJc73i3Q3bVZ3LukYdC-9Xo" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/capacities
GET /1.1/1783/users/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer ZRatuWfmE0_OS1gAPS77gJc73i3Q3bVZ3LukYdC-9Xo
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": 4287,
"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/1782/users/4285/capacities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ep6tBnXHDQGN7FADNMs3jQRUGLv-IGXLlGnv6QTNbw4" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/capacities
GET /1.1/1782/users/4285/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ep6tBnXHDQGN7FADNMs3jQRUGLv-IGXLlGnv6QTNbw4
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/1785/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":1698,"hour_rate":10}]},"name":null,"admin":{"id":1452,"email":"notifications@timelyapp.com","created_at":"2022-06-16T15:57:27.000+02:00","updated_at":"2022-06-16T15:57:27.000+02:00","name":"Timely","notifier":false}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 3oACmeAmrZwMBE1VN3ioLB8pUSHWRatzQsRZEvY5EwI" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users
POST /1.1/1785/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3oACmeAmrZwMBE1VN3ioLB8pUSHWRatzQsRZEvY5EwI
Parameters
{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":1698,"hour_rate":10}]},"name":null,"admin":{"id":1452,"email":"notifications@timelyapp.com","created_at":"2022-06-16T15:57:27.000+02:00","updated_at":"2022-06-16T15:57:27.000+02:00","name":"Timely","notifier":false}}
Name | Description |
---|---|
user required | User attributes |
name required | Specifies the user name |
email required | Specifies the user email |
projects | Description: Specifies the projects that the user will be part of. For example: "projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }] |
role_id required | Specifies the user's role in the account |
user_level | (Deprecated) Specifies the user level; either “normal” or “limited”. The default is "normal". For example: "user_level": "normal" |
admin | (Deprecated) Specifies the user is an admin. In this case user_level should be “normal”. For example: "admin": "true" |
external_id | The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters) |
weekly_capacity | Specifies the user's weekly hour capacity. The default is account's weekly capacity. To avoid rounding issues, values are allowed upto 1 decimal place and divisible by 5. |
add_to_all_projects | Specifies whether the user should be added to all projects in the account. For example: "add_to_all_projects":true |
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": 4293,
"email": "marija@timely.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": false,
"memory_onboarded": false,
"created_at": 1655387847,
"updated_at": 1655387847,
"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%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
},
"type": "User",
"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": 5354,
"role": {
"id": 5354,
"name": "manager"
},
"accounts_waiting_acknowledgement": [
{
"account_id": 1785,
"account_sitename": "Timely",
"memory_retention_days": 0
}
]
}
Delete a user
Request
curl "https://api.timelyapp.com/1.1/1786/users/4294" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 5NJxMiN1oyO8MhYA9jTsgXIFwk5aaebHNhqVCwOu470" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/users/:id
DELETE /1.1/1786/users/4294
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5NJxMiN1oyO8MhYA9jTsgXIFwk5aaebHNhqVCwOu470
Parameters
Name | Description |
---|---|
account_id | The account ID containing the user you want to delete |
id | The ID of the user you want to delete |
Response
Content-Type: application/json; charset=utf-8
200 OK
{}
List all users
Note: The user list will return the 10 most recently updated users.
Request
curl -g "https://api.timelyapp.com/1.1/1789/users" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer xvFMnKiBOtAslROaBl20vzJ3LVmRKTRRdVnrtiZiMTU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users
GET /1.1/1789/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer xvFMnKiBOtAslROaBl20vzJ3LVmRKTRRdVnrtiZiMTU
Parameters
Name | Description |
---|---|
account_id | The account ID containing the users you want to retrieve |
limit | Retrieve a limited number of users |
offset | Retrieve users from offset |
order | Sorting order on updated_at |
filter | Filter users - Ex: filter=deleted |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 4300,
"email": "marijazxtrkwxu@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1655387849,
"updated_at": 1655387849,
"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/7ece0856ccf24e293717abcbf9bd5593?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/7ece0856ccf24e293717abcbf9bd5593?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/7ece0856ccf24e293717abcbf9bd5593?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/7ece0856ccf24e293717abcbf9bd5593?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/7ece0856ccf24e293717abcbf9bd5593?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/7ece0856ccf24e293717abcbf9bd5593?d=http%3A%2F%2Fapp.timelyapp.local%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": 5365,
"role": {
"id": 5365,
"name": "admin"
},
"accounts_waiting_acknowledgement": [
{
"account_id": 1789,
"account_sitename": "Timely",
"memory_retention_days": 0
}
]
}
]
Retrieve a user
Request
curl -g "https://api.timelyapp.com/1.1/1787/users/4296" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ryyrqg1PQeResdNqkV6Rqg7IHOJGWgzNpHdF2drRXQY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:id
GET /1.1/1787/users/4296
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ryyrqg1PQeResdNqkV6Rqg7IHOJGWgzNpHdF2drRXQY
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": 4296,
"email": "marijanbtxkktp@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1655387848,
"updated_at": 1655387848,
"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/8a10942b5e0801e06a3ac8cb068517c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/8a10942b5e0801e06a3ac8cb068517c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/8a10942b5e0801e06a3ac8cb068517c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/8a10942b5e0801e06a3ac8cb068517c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/8a10942b5e0801e06a3ac8cb068517c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/8a10942b5e0801e06a3ac8cb068517c1?d=http%3A%2F%2Fapp.timelyapp.local%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": 5359,
"role": {
"id": 5359,
"name": "admin"
},
"accounts_waiting_acknowledgement": [
{
"account_id": 1787,
"account_sitename": "Timely",
"memory_retention_days": 0
}
]
}
Retrieve current user
Request
curl -g "https://api.timelyapp.com/1.1/1788/users/current" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer _ew0y9GqxNN60FNG6Va1cNZNtCn1M79dC_fAcX-RMiQ" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current
GET /1.1/1788/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer _ew0y9GqxNN60FNG6Va1cNZNtCn1M79dC_fAcX-RMiQ
Parameters
Name | Description |
---|---|
account_id | The account ID containing the current user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 4298,
"email": "marijabwgecmrd@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1655387848,
"updated_at": 1655387848,
"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/1640256d8bb7ebe41777f55acd122617?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/1640256d8bb7ebe41777f55acd122617?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/1640256d8bb7ebe41777f55acd122617?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/1640256d8bb7ebe41777f55acd122617?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/1640256d8bb7ebe41777f55acd122617?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/1640256d8bb7ebe41777f55acd122617?d=http%3A%2F%2Fapp.timelyapp.local%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": 5362,
"role": {
"id": 5362,
"name": "admin"
},
"accounts_waiting_acknowledgement": [
{
"account_id": 1788,
"account_sitename": "Timely",
"memory_retention_days": 0
}
]
}
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/1790/users/4302" -d '{"user":{"admin":{"id":1457,"email":"notifications@timelyapp.com","created_at":"2022-06-16T15:57:29.000+02:00","updated_at":"2022-06-16T15:57:29.000+02:00","name":"Timely","notifier":false},"role_id":5368,"projects":[{"project_id":1703,"hour_rate":10}]}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer yBEvfuAGHMYjoJ_tE2YbUlxTDxmunWfR4NACbyOfXk0" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:id
PUT /1.1/1790/users/4302
Accept: application/json
Content-Type: application/json
Authorization: Bearer yBEvfuAGHMYjoJ_tE2YbUlxTDxmunWfR4NACbyOfXk0
Parameters
{"user":{"admin":{"id":1457,"email":"notifications@timelyapp.com","created_at":"2022-06-16T15:57:29.000+02:00","updated_at":"2022-06-16T15:57:29.000+02:00","name":"Timely","notifier":false},"role_id":5368,"projects":[{"project_id":1703,"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": 4302,
"email": "marijaelshkkfn@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1655387849,
"updated_at": 1655387849,
"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/e8ea4027dd79cb86b492af8a2155733f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"large": "https://www.gravatar.com/avatar/e8ea4027dd79cb86b492af8a2155733f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/e8ea4027dd79cb86b492af8a2155733f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/e8ea4027dd79cb86b492af8a2155733f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/e8ea4027dd79cb86b492af8a2155733f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
"small": "https://www.gravatar.com/avatar/e8ea4027dd79cb86b492af8a2155733f?d=http%3A%2F%2Fapp.timelyapp.local%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": 5368,
"role": {
"id": 5368,
"name": "admin"
},
"accounts_waiting_acknowledgement": [
{
"account_id": 1790,
"account_sitename": "Timely",
"memory_retention_days": 0
}
]
}
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. |