Introduction
Welcome! 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
Authentication
OAuth2 Authentication: http://tools.ietf.org/html/rfc6749
Create a OAuth Application (only available to the Admin User): https://timelyapp.com/:account_id/oauth_applications
Enter your application name and the redirect_url to your application.
Acquire the Application Id and Secret.
Base URL for all API's is: https://api.timelyapp.com/1.1
Authorization
OAuth Code
Example Request: (try this in 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 account
Returns all accounts created within 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 n5lwTcRTkNniYTRMB_YoC5MoSPiAI4biico9VC-nX9Y" \
-H "Cookie: "
Endpoint
GET /1.1/accounts
GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer n5lwTcRTkNniYTRMB_YoC5MoSPiAI4biico9VC-nX9Y
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 11331,
"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.png",
"medium_retina": "/assets/account_thumbs/account_medium_retina.png",
"small_retina": "/assets/account_thumbs/account_small_retina.png"
},
"from": "Web",
"max_users": 0,
"max_projects": 0,
"num_users": 1,
"num_projects": 0,
"plan_id": 11719,
"plan_name": "Essential",
"next_charge": "2019-09-13",
"start_of_week": 0,
"beta": false,
"created_at": 1565689186,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"capacity": {
"hours": 40.0,
"minutes": 0.0,
"seconds": 0.0,
"formatted": "40:00",
"total_hours": 40.0,
"total_seconds": 144000.0,
"total_minutes": 2400.0
},
"plan_code": "essential",
"appstore_transaction_id": null,
"owner_id": 26161,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "control",
"days": -1
},
{
"name": "memories",
"days": -1
},
{
"name": "billing",
"days": -1
},
{
"name": "project_labels",
"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": "integrations",
"days": -1
},
{
"name": "anomalies",
"days": -1
},
{
"name": "log_hours_for_others",
"days": -1
},
{
"name": "budgets_time",
"days": -1
},
{
"name": "budgets_money",
"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": "priority_support",
"days": -1
},
{
"name": "planning",
"days": -1
}
]
}
]
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/11330" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer gXh8rwXp5f7nLqZDmtm7LILlUuA9J62O70TpV0Fjuts" \
-H "Cookie: "
Endpoint
GET /1.1/accounts/:id
GET /1.1/accounts/11330
Accept: application/json
Content-Type: application/json
Authorization: Bearer gXh8rwXp5f7nLqZDmtm7LILlUuA9J62O70TpV0Fjuts
Parameters
| Name | Description |
|---|---|
| id | The id of the account to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 11330,
"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.png",
"medium_retina": "/assets/account_thumbs/account_medium_retina.png",
"small_retina": "/assets/account_thumbs/account_small_retina.png"
},
"from": "Web",
"max_users": 0,
"max_projects": 0,
"num_users": 1,
"num_projects": 0,
"plan_id": 11718,
"plan_name": "Essential",
"next_charge": "2019-09-13",
"start_of_week": 0,
"beta": false,
"created_at": 1565689185,
"payment_mode": "web",
"paid": true,
"company_size": "10-49",
"capacity": {
"hours": 40.0,
"minutes": 0.0,
"seconds": 0.0,
"formatted": "40:00",
"total_hours": 40.0,
"total_seconds": 144000.0,
"total_minutes": 2400.0
},
"plan_code": "essential",
"appstore_transaction_id": null,
"owner_id": 26159,
"expired": false,
"trial": false,
"days_to_end_trial": 0,
"features": [
{
"name": "control",
"days": -1
},
{
"name": "memories",
"days": -1
},
{
"name": "billing",
"days": -1
},
{
"name": "project_labels",
"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": "integrations",
"days": -1
},
{
"name": "anomalies",
"days": -1
},
{
"name": "log_hours_for_others",
"days": -1
},
{
"name": "budgets_time",
"days": -1
},
{
"name": "budgets_money",
"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": "priority_support",
"days": -1
},
{
"name": "planning",
"days": -1
}
]
}
Retrieve the activities
This endpoint shows you all activities done by you and/or the members that you have permission to see upon, such as: logging hours, create a report, share a report and similar activities.
Request
curl -g "https://api.timelyapp.com/1.1/11329/activities" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer mmi4kCfR7Gq97mSkBqQxZWnfA5Jm1MeH6ObxJgreABk" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/activities
GET /1.1/11329/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer mmi4kCfR7Gq97mSkBqQxZWnfA5Jm1MeH6ObxJgreABk
Parameters
| Name | Description |
|---|---|
| account_id | The id of the account to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
]
Clients
A client can be a company which user works for. User can have multiple companies/clients.
Create a client
This api allows you to create a client for an account.
Request
curl "https://api.timelyapp.com/1.1/11349/clients" -d '{"client":{"name":"Timely","active":true}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 4ZSOT3qbjqIpw8qJuATOPteD9DY0AxcTtBMYfr-m32c" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/clients
POST /1.1/11349/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer 4ZSOT3qbjqIpw8qJuATOPteD9DY0AxcTtBMYfr-m32c
Parameters
{"client":{"name":"Timely","active":true}}
| Name | Description |
|---|---|
| name required | Specifies the client name |
| active | Change the client state to archived if set to true. Example values: true or false |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 6887,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:39:55+02:00"
}
List all clients
This api will return the list of all clients details created for one account.
NOTE: Client list will return recently updated 10 clients.
Request
curl -g "https://api.timelyapp.com/1.1/11350/clients" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer M24BhKVkduSBII8trEWOhaOvZwC5Ed9i86tqAsb2RAU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/clients
GET /1.1/11350/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer M24BhKVkduSBII8trEWOhaOvZwC5Ed9i86tqAsb2RAU
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which clients to be retrieved |
| show | Specifies which records to retrieve, default is current accounts active clients (show=active). Example: "show=all" or "show=active" or "show=archived" |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 6888,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:39:55+02:00"
}
]
Update a client
Using a client's id one can update client details.
Request
curl "https://api.timelyapp.com/1.1/11351/clients/6889" -d '{"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 qmEyoemeirthdSaEjT55xWq4-a9VTWaeJC8KbInKljk" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/clients/:id
PUT /1.1/11351/clients/6889
Accept: application/json
Content-Type: application/json
Authorization: Bearer qmEyoemeirthdSaEjT55xWq4-a9VTWaeJC8KbInKljk
Parameters
{"client":{"name":"Updated name","active":true}}
| Name | Description |
|---|---|
| id required | Client id |
| name required | Specifies the client name |
| active | Change the client state to archived if set to true. Example values: true or false |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 6889,
"name": "Updated name",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:39:56+02:00"
}
Events
Evens represent all entries made by user. A user can add, delete and edit all entries. Limited users might have less privileges.
Create an event
Logged in user creating an event for self.
Note: By default the event is created for user’s last hour project or the first active project.
Request
curl "https://api.timelyapp.com/1.1/11368/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-08-13T11:40:01.960+02:00","to":"2019-08-13T15:10:01.960+02:00","day":"2019-08-13","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"logged_at":"2019-08-13T11:40:01.961+02:00","timer_state":0,"created_from":"Web","updated_from":"Web","project_id":9199}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer lfE6SdpzjcPy2InpMnJqdaELUbx2YOivzSd_tc54hGU" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/events
POST /1.1/11368/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer lfE6SdpzjcPy2InpMnJqdaELUbx2YOivzSd_tc54hGU
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-08-13T11:40:01.960+02:00","to":"2019-08-13T15:10:01.960+02:00","day":"2019-08-13","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"logged_at":"2019-08-13T11:40:01.961+02:00","timer_state":0,"created_from":"Web","updated_from":"Web","project_id":9199}}
| Name | Description |
|---|---|
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| estimated_minutes | Specifies the event estimated minutes. Example Values: 0-60 |
| estimated_hours | Specifies the event estimated hours. Example Values: 0-12 |
| note | Specifies the event notes. |
| from | Specifies the from time. Example Values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the to time. Example Values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies the label ids. Example Values: label_ids:[2,3,4] |
| project_id | Specifies the project id |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 8440,
"uid": "eba55fca4575e35eec8587f10ba60a43",
"user": {
"id": 26240,
"email": "marijataruyyfk@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/69f8a687f555e632aff04895380864c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/69f8a687f555e632aff04895380864c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/69f8a687f555e632aff04895380864c1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:01+02:00"
},
"project": {
"id": 9199,
"active": true,
"account_id": 11368,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689201,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6895,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:01+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"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": 1565689202,
"created_at": 1565689202,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:01+02:00",
"from": "2019-08-13T11:40:01+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 26240,
"updater_id": 26240,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Create an event for a project
Note: Normal user can add hours to existing projects from account. Limited user can add hours to only his projects.
Request
curl "https://api.timelyapp.com/1.1/11367/projects/9198/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-08-13T11:40:01.214+02:00","to":"2019-08-13T15:10:01.214+02:00","day":"2019-08-13","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"logged_at":"2019-08-13T11:40:01.214+02:00","timer_state":0,"created_from":"Web","updated_from":"Web","project_id":9198}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer PfxcIbdP1CuK9-GZrrR9LQW40wmIKIbU3W-tPAALqZE" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects/:project_id/events
POST /1.1/11367/projects/9198/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer PfxcIbdP1CuK9-GZrrR9LQW40wmIKIbU3W-tPAALqZE
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-08-13T11:40:01.214+02:00","to":"2019-08-13T15:10:01.214+02:00","day":"2019-08-13","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"logged_at":"2019-08-13T11:40:01.214+02:00","timer_state":0,"created_from":"Web","updated_from":"Web","project_id":9198}}
| Name | Description |
|---|---|
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| project_id required | The numerical ID of the desired project. Example Values: 123 |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 8439,
"uid": "c480540d4e8c0cf7ad03ba949e3a5280",
"user": {
"id": 26238,
"email": "marijadojfvvfa@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/74d9785da1eea9b42c0656f6285c1767?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/74d9785da1eea9b42c0656f6285c1767?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/74d9785da1eea9b42c0656f6285c1767?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:00+02:00"
},
"project": {
"id": 9198,
"active": true,
"account_id": 11367,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689201,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6894,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:01+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"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": 1565689201,
"created_at": 1565689201,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:01+02:00",
"from": "2019-08-13T11:40:01+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 26238,
"updater_id": 26238,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Create an event for another user
Note: Normal user can add hours for any user. If project_id is not provided, the event is created for user’s last hour project or the first active project.
Request
curl "https://api.timelyapp.com/1.1/11366/users/26236/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-08-13T11:40:00.442+02:00","to":"2019-08-13T15:10:00.442+02:00","day":"2019-08-13","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"logged_at":"2019-08-13T11:40:00.442+02:00","timer_state":0,"created_from":"Web","updated_from":"Web","user_id":26236}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer kMnZVvp_Ul4VrjcUdSG-JeLsFKasR4VEfe1BTo5KWYY" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users/:user_id/events
POST /1.1/11366/users/26236/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer kMnZVvp_Ul4VrjcUdSG-JeLsFKasR4VEfe1BTo5KWYY
Parameters
{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-08-13T11:40:00.442+02:00","to":"2019-08-13T15:10:00.442+02:00","day":"2019-08-13","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"logged_at":"2019-08-13T11:40:00.442+02:00","timer_state":0,"created_from":"Web","updated_from":"Web","user_id":26236}}
| Name | Description |
|---|---|
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| user_id required | The numerical ID of the desired user. Example Values: 123 |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 8438,
"uid": "63ceea56ae1563b4477506246829b386",
"user": {
"id": 26236,
"email": "marijavncmfcjm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/27b8e5179c8d2d5ceffb24be3f853a9e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/27b8e5179c8d2d5ceffb24be3f853a9e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/27b8e5179c8d2d5ceffb24be3f853a9e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:39:59+02:00"
},
"project": {
"id": 9197,
"active": true,
"account_id": 11366,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689200,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6893,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:00+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"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": 1565689200,
"created_at": 1565689200,
"created_from": "Timely",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:00+02:00",
"from": "2019-08-13T11:40:00+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": 26236,
"updater_id": 26236,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Delete an event
Note: Normal user can delete events of other projects of same account. Limited user can delete only his events.
Request
curl "https://api.timelyapp.com/1.1/11369/events/8441" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer -62rjp_0k5v0QfguzsjpjFt_MhJ3_AfwT-sRA2RSRSc" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/events/:id
DELETE /1.1/11369/events/8441
Accept: application/json
Content-Type: application/json
Authorization: Bearer -62rjp_0k5v0QfguzsjpjFt_MhJ3_AfwT-sRA2RSRSc
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which hour to be deleted |
| id required | The id of the hour to be deleted |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all events
Get all the events of active projects present in user’s account.
Note: If “since” and “upto” parameters are not passed, default period is current day.
Request
curl -g "https://api.timelyapp.com/1.1/11371/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer oa9GkbFx-T7xFXIo3SXBxSXsenzzsKCAO9J876hTuKI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events
GET /1.1/11371/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer oa9GkbFx-T7xFXIo3SXBxSXsenzzsKCAO9J876hTuKI
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which hours to be retrieved |
| since | Specifies the start date for results to return. Example: since=2014-08-18 |
| upto | Specifies the end date for results to return. Example: upto=2014-08-24 |
| day | Specifies the day date for results to return. Example: day=2014-08-24 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 8443,
"uid": "7e6b20d014d1c659e4eaf20dc2dcd7eb",
"user": {
"id": 26246,
"email": "marijaboajkpie@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/5090643f044077b6fadf493b0fa761ae?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5090643f044077b6fadf493b0fa761ae?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5090643f044077b6fadf493b0fa761ae?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:03+02:00"
},
"project": {
"id": 9202,
"active": true,
"account_id": 11371,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689203,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6898,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:03+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"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": 1565689203,
"created_at": 1565689203,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2019-08-13T15:10:03+02:00",
"from": "2019-08-13T11:40:03+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
]
List all events for project
Note: Only normal user can get events of other projects of same account. Limited user can only get events of his own project.
Request
curl -g "https://api.timelyapp.com/1.1/11373/projects/9204/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer to05p4tffIDBoQZf5qoyeza7R-7TNUvUMqmwKcOs5FY" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:project_id/events
GET /1.1/11373/projects/9204/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer to05p4tffIDBoQZf5qoyeza7R-7TNUvUMqmwKcOs5FY
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which hours to be retrieved |
| project_id | Project id for which hours to be retrieved |
| since | Specifies the start date for results to return. Example: since=2014-08-18 |
| upto | Specifies the end date for results to return. Example: upto=2014-08-24 |
| day | Specifies the day date for results to return. Example: day=2014-08-24 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 8445,
"uid": "e3d11d85deaf57a720d252cd069bcd37",
"user": {
"id": 26250,
"email": "marijadoxkrpni@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/071c5625e6440f76b26c322e0aea0e5d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/071c5625e6440f76b26c322e0aea0e5d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/071c5625e6440f76b26c322e0aea0e5d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:04+02:00"
},
"project": {
"id": 9204,
"active": true,
"account_id": 11373,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689205,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6900,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:05+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"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": 1565689205,
"created_at": 1565689205,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2019-08-13T15:10:05+02:00",
"from": "2019-08-13T11:40:05+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
]
List all events for user
Note: Only normal user can get events of other users of same account. Limited user will always get his one events.
Request
curl -g "https://api.timelyapp.com/1.1/11372/users/26248/events" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer GQDuiI-IaQCElpHH_y7yV8g7BcjZVZgF8vOHflXM178" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:user_id/events
GET /1.1/11372/users/26248/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer GQDuiI-IaQCElpHH_y7yV8g7BcjZVZgF8vOHflXM178
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which hours to be retrieved |
| user_id | User id for which hours to be retrieved |
| since | Specifies the start date for results to return. Example: since=2014-08-18 |
| upto | Specifies the end date for results to return. Example: upto=2014-08-24 |
| day | Specifies the day date for results to return. Example: day=2014-08-24 |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 8444,
"uid": "c24f4c5eef7ec01c46e003a9296c8645",
"user": {
"id": 26248,
"email": "marijasyrosysm@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/3931876d4c125d1b25a5e924e09b5f81?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/3931876d4c125d1b25a5e924e09b5f81?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/3931876d4c125d1b25a5e924e09b5f81?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:04+02:00"
},
"project": {
"id": 9203,
"active": true,
"account_id": 11372,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689204,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6899,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:04+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"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": 1565689204,
"created_at": 1565689204,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2019-08-13T15:10:04+02:00",
"from": "2019-08-13T11:40:04+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
]
Logged in user updating details and user of an event
Note: Normal user can edit event’s user to one of his account’s user. Limited user can not edit user.
Request
curl "https://api.timelyapp.com/1.1/11378/users/26260/events/8450" -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 hrBF5SKntqh2nptrhNGE2auYu5Iv4HRzUMpVTgIz0Qk" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:user_id/events/:id
PUT /1.1/11378/users/26260/events/8450
Accept: application/json
Content-Type: application/json
Authorization: Bearer hrBF5SKntqh2nptrhNGE2auYu5Iv4HRzUMpVTgIz0Qk
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 the event estimated minutes. Example Values: 0-60 |
| estimated_hours | Specifies the event estimated hours. Example Values: 0-12 |
| note | Specifies the event notes. |
| from | Specifies the from time. Example Values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the to time. Example Values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies the label ids. Example Values: label_ids:[2,3,4] |
| project_id | Project id |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 8450,
"uid": "f80ebff16ccaa9b48a0224d7c489cef4",
"user": {
"id": 26260,
"email": "marijaypwgzbyy@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/ce09b5f64c0327ffe158b6753d48fe79?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/ce09b5f64c0327ffe158b6753d48fe79?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/ce09b5f64c0327ffe158b6753d48fe79?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:08+02:00"
},
"project": {
"id": 9209,
"active": true,
"account_id": 11378,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689208,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6905,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:08+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 10000,
"formatted": "$100.00",
"amount": 100.0
},
"day": "2019-08-13",
"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": 1565689208,
"created_at": 1565689208,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:08+02:00",
"from": "2019-08-13T11:40:08+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 26260,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Loggedin user updating details and project of his event
Request
curl "https://api.timelyapp.com/1.1/11377/projects/9208/events/8449" -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 sgy_1gOBXArI_DNg0WyRKva_ZyD9OzI7jn-yZRTotBM" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:project_id/events/:id
PUT /1.1/11377/projects/9208/events/8449
Accept: application/json
Content-Type: application/json
Authorization: Bearer sgy_1gOBXArI_DNg0WyRKva_ZyD9OzI7jn-yZRTotBM
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 | Event id |
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| estimated_minutes | Specifies the event estimated minutes. Example Values: 0-60 |
| estimated_hours | Specifies the event estimated hours. Example Values: 0-12 |
| note | Specifies the event notes. |
| from | Specifies the from time. Example Values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the to time. Example Values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies the label ids. 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 |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 8449,
"uid": "deee9fe5195586bf4545518a76aff2f7",
"user": {
"id": 26258,
"email": "marijahmohwugi@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/b245bdf16a287ca2b3ab8857e03d53d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/b245bdf16a287ca2b3ab8857e03d53d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/b245bdf16a287ca2b3ab8857e03d53d4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:07+02:00"
},
"project": {
"id": 9208,
"active": true,
"account_id": 11377,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689207,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6904,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:07+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 10000,
"formatted": "$100.00",
"amount": 100.0
},
"day": "2019-08-13",
"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": 1565689208,
"created_at": 1565689207,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:07+02:00",
"from": "2019-08-13T11:40:07+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 26258,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Retrieve an event
Request
curl -g "https://api.timelyapp.com/1.1/11370/events/8442" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer WauG6yed8ugzqw7EifVQCvBfE3yXYhHTh3Nf8bmU9Bs" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/events/:id
GET /1.1/11370/events/8442
Accept: application/json
Content-Type: application/json
Authorization: Bearer WauG6yed8ugzqw7EifVQCvBfE3yXYhHTh3Nf8bmU9Bs
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which hour to be retrieved |
| id | The id of the hour to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 8442,
"uid": "915e3742d51cb477268ba29275c3ce09",
"user": {
"id": 26244,
"email": "marijatmvcoxqt@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/5c50a80feba0425bbbb47e3dc5423f8b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/5c50a80feba0425bbbb47e3dc5423f8b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5c50a80feba0425bbbb47e3dc5423f8b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:02+02:00"
},
"project": {
"id": 9201,
"active": true,
"account_id": 11370,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689203,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6897,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:03+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"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": 1565689203,
"created_at": 1565689203,
"created_from": "Web",
"updated_from": "Web",
"billed": false,
"to": "2019-08-13T15:10:03+02:00",
"from": "2019-08-13T11:40:03+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": null,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Start timer on event
Request
curl "https://api.timelyapp.com/1.1/11374/events/8446/start" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer LmwaSrm4IKWItiGB8l_Xo-snZ7MdRjsQp3N_Cpa_6Wg" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/start
PUT /1.1/11374/events/8446/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer LmwaSrm4IKWItiGB8l_Xo-snZ7MdRjsQp3N_Cpa_6Wg
Parameters
| Name | Description |
|---|---|
| id required | Event id |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 8446,
"uid": "eec96a7f788e88184c0e713456026f3f",
"user": {
"id": 26252,
"email": "marijayhqpxnkj@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/a94a8e8b774e62659d069bf71f46561b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/a94a8e8b774e62659d069bf71f46561b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/a94a8e8b774e62659d069bf71f46561b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:05+02:00"
},
"project": {
"id": 9205,
"active": true,
"account_id": 11374,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689205,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6901,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:05+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 3,
"minutes": 30,
"seconds": 0,
"formatted": "03:30",
"total_hours": 3.5,
"total_seconds": 12600,
"total_minutes": 210
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 17500,
"formatted": "$175.00",
"amount": 175.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "start",
"timer_started_on": 1565689205,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1565689205,
"created_at": 1565689205,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:05+02:00",
"from": "2019-08-13T11:40:05+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 26252,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Stop timer on event
Request
curl "https://api.timelyapp.com/1.1/11375/events/8447/stop" -d '' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer fEMXp6U_tyoNNpVqNAJESIfUdREKLYWAQCRZ0mdPcac" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id/stop
PUT /1.1/11375/events/8447/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer fEMXp6U_tyoNNpVqNAJESIfUdREKLYWAQCRZ0mdPcac
Parameters
| Name | Description |
|---|---|
| id required | Event id |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 8447,
"uid": "67b4e63655366f054314061dadd539a0",
"user": {
"id": 26254,
"email": "marijagulikspk@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/01b4bec07fe8772c780ec5e29756fb4d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/01b4bec07fe8772c780ec5e29756fb4d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/01b4bec07fe8772c780ec5e29756fb4d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:06+02:00"
},
"project": {
"id": 9206,
"active": true,
"account_id": 11375,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689206,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6902,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:06+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 4,
"minutes": 30,
"seconds": 0,
"formatted": "04:30",
"total_hours": 4.5,
"total_seconds": 16200,
"total_minutes": 270
},
"estimated_duration": {
"hours": 4,
"minutes": 0,
"seconds": 0,
"formatted": "04:00",
"total_hours": 4.0,
"total_seconds": 14400,
"total_minutes": 240
},
"cost": {
"fractional": 22500,
"formatted": "$225.00",
"amount": 225.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
},
"day": "2019-08-13",
"note": "Notes for testing with some random #hash in it.",
"sequence": 1,
"estimated": false,
"timer_state": "stop",
"timer_started_on": 0,
"timer_stopped_on": 1565689206,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1565689206,
"created_at": 1565689206,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:06+02:00",
"from": "2019-08-13T11:40:06+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 26254,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Update an event
Logged in user updating self event
Note: If its a normal user then he can edit events of other users of his account. Also the project_id can be edited to one from his account. If limited user, then he can edit only his events.
Request
curl "https://api.timelyapp.com/1.1/11376/events/8448" -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 28vN-Re2p0yorXUjnB1zL1pL50s61Rk_eKDTmVubyeM" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/events/:id
PUT /1.1/11376/events/8448
Accept: application/json
Content-Type: application/json
Authorization: Bearer 28vN-Re2p0yorXUjnB1zL1pL50s61Rk_eKDTmVubyeM
Parameters
{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
| Name | Description |
|---|---|
| id required | Event id |
| day required | Event day |
| hours required | Event hours |
| minutes required | Event minutes |
| project_id | Project id |
| estimated_minutes | Specifies the event estimated minutes. Example Values: 0-60 |
| estimated_hours | Specifies the event estimated hours. Example Values: 0-12 |
| note | Specifies the event notes. |
| from | Specifies the from time. Example Values: from: "2017-05-26T10:00:00+05:30" |
| to | Specifies the to time. Example Values: to: "2017-05-26T12:00:00+05:30" |
| label_ids | Specifies the label ids. 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 |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 8448,
"uid": "44590aa922914066f965ae67be0222d2",
"user": {
"id": 26256,
"email": "marijahyqxmvdr@timelyapp.com",
"name": "Marija Petrovic",
"avatar": {
"timeline": "https://www.gravatar.com/avatar/70eb364af5b626a4e65b6bc50be15ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/70eb364af5b626a4e65b6bc50be15ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/70eb364af5b626a4e65b6bc50be15ad6?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s="
},
"updated_at": "2019-08-13T11:40:06+02:00"
},
"project": {
"id": 9207,
"active": true,
"account_id": 11376,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689207,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6903,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:07+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"labels": [
],
"label_ids": [
],
"required_label_ids": [
]
},
"duration": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"formatted": "00:00",
"total_hours": 0.0,
"total_seconds": 0,
"total_minutes": 0
},
"estimated_duration": {
"hours": 2,
"minutes": 0,
"seconds": 0,
"formatted": "02:00",
"total_hours": 2.0,
"total_seconds": 7200,
"total_minutes": 120
},
"cost": {
"fractional": 0,
"formatted": "$0.00",
"amount": 0.0
},
"estimated_cost": {
"fractional": 10000,
"formatted": "$100.00",
"amount": 100.0
},
"day": "2019-08-13",
"note": "Updated notes",
"sequence": 1,
"estimated": true,
"timer_state": "default",
"timer_started_on": 0,
"timer_stopped_on": 0,
"label_ids": [
],
"user_ids": [
],
"updated_at": 1565689207,
"created_at": 1565689207,
"created_from": "Web",
"updated_from": "Timely",
"billed": false,
"to": "2019-08-13T15:10:07+02:00",
"from": "2019-08-13T11:40:07+02:00",
"deleted": false,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"creator_id": null,
"updater_id": 26256,
"external_id": null,
"entry_ids": [
],
"suggestion_id": null
}
Labels
Labels/Tags help you classify the work, group related work and also to set some requirements. This api allows you to create, list, update and delete tags created within one account.
Create a label
Request
curl "https://api.timelyapp.com/1.1/11381/labels" -d '{"label":{"name":"Web Programming"}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer cHw_j615eOaNwulIzFh2e3WrSarAVcKtVLerG2nbJAY" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/labels
POST /1.1/11381/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer cHw_j615eOaNwulIzFh2e3WrSarAVcKtVLerG2nbJAY
Parameters
{"label":{"name":"Web Programming"}}
| Name | Description |
|---|---|
| name required | Specifies the label name |
| emoji | Specifies the emoji url for label |
| parent_id | Set the parent_id if you want to create child label |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 5196,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"children": [
]
}
Delete a label
Request
curl "https://api.timelyapp.com/1.1/11382/labels/5197" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 6s9Lx-MYYx2u8W6IjAs7-JxDl0AhlVfXG2y1VFtMhr4" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/labels/:id
DELETE /1.1/11382/labels/5197
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6s9Lx-MYYx2u8W6IjAs7-JxDl0AhlVfXG2y1VFtMhr4
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which label to be deleted |
| id | The id of the label to be deleted |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all child labels
Get all child of given tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/11385/labels?parent_id=5199" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer FWBR19C-D9rAzchB1iMUA9H6CSAu5G61ayqacI_5qBI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/11385/labels?parent_id=5199
Accept: application/json
Content-Type: application/json
Authorization: Bearer FWBR19C-D9rAzchB1iMUA9H6CSAu5G61ayqacI_5qBI
Parameters
parent_id: 5199
| Name | Description |
|---|---|
| account_id | Account id for which label to be retrieved |
| parent_id | The id of the parent label to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5199,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"children": [
]
}
List all label
Get all the tags present in user’s account.
Request
curl -g "https://api.timelyapp.com/1.1/11384/labels" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 0E9ejTrFFoQko5yrdPtmXZZFBIcSCwhG2gtMWser0A8" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels
GET /1.1/11384/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0E9ejTrFFoQko5yrdPtmXZZFBIcSCwhG2gtMWser0A8
Parameters
None known.
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/11383/labels/5198" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer XufiQhnajmA92jLgT2ruqZ68GunLztVZxbNkDPXz6MI" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/labels/:id
GET /1.1/11383/labels/5198
Accept: application/json
Content-Type: application/json
Authorization: Bearer XufiQhnajmA92jLgT2ruqZ68GunLztVZxbNkDPXz6MI
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which label to be retrieved |
| id | The id of the label to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5198,
"name": "Web Programming",
"sequence": 1,
"parent_id": null,
"emoji": null,
"children": [
]
}
Update a label
Request
curl "https://api.timelyapp.com/1.1/11386/labels/5200" -d '{"label":{"name":"updated name"}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Ozu2Gn7Q4uFE_Dri0s5BH-Vw5zh0Geo4Xvn6BS_0xoI" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/labels/:id
PUT /1.1/11386/labels/5200
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ozu2Gn7Q4uFE_Dri0s5BH-Vw5zh0Geo4Xvn6BS_0xoI
Parameters
{"label":{"name":"updated name"}}
| Name | Description |
|---|---|
| id required | Label id |
| name required | Specifies the label name |
| emoji | Specifies the emoji url for tag |
| parent_id | Set the parent_id if you want to create child tags |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 5200,
"name": "updated name",
"sequence": 1,
"parent_id": null,
"emoji": null,
"children": [
]
}
Projects
Project object contains all project details of a logged account. With this api you can retrieve a specific project or the list of all projects, update, create and delete a project.
Create a project
Request
curl "https://api.timelyapp.com/1.1/11402/projects" -d '{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":6925,"budget_type":"M","budget":300,"users":[{"user_id":26305}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":5201,"required":true},{"label_id":5202,"required":true},{"label_id":5203,"required":false},{"label_id":5204,"required":false}]}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer bEQa1YjQbsajHG0Dsyd32RTWig1I5mA8D7cf1TMoMZ4" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/projects
POST /1.1/11402/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer bEQa1YjQbsajHG0Dsyd32RTWig1I5mA8D7cf1TMoMZ4
Parameters
{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":6925,"budget_type":"M","budget":300,"users":[{"user_id":26305}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":5201,"required":true},{"label_id":5202,"required":true},{"label_id":5203,"required":false},{"label_id":5204,"required":false}]}}
| Name | Description |
|---|---|
| project required | Project attributes |
| name required | Specifies the project name |
| color required | Specifies the project color, should be one of 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0 |
| client_id required | Specifies the numerical client id |
| users required | Specifies the project users, should be array of users with numerical user id and hour_rate Example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }] |
| billable | Specifies the project is billable or not, should be true or false |
| budget | Specifies the budget for project, should be numeric value |
| hour_rate | Specifies the hour rate for project, should be numeric value |
| rate_type | Specifies the hour rate type for project, should be 'user' or 'project' |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
| budget_recurrence | It specifies when the recurrence of budget will occur |
| send_invite | Specifies if you want to send project invite email, should be true or false |
| required_notes | Project hours notes 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 }] |
Response
Content-Type: application/json; charset=utf-8
201 Created
{
"id": 9230,
"active": true,
"account_id": 11402,
"name": "New Project",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689215,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6925,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:15+02:00"
},
"required_notes": false,
"budget": 300,
"budget_type": "M",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"users": [
{
"user_id": 26305,
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"updated_at": "2019-08-13T11:40:15+02:00",
"deleted": false
}
],
"labels": [
{
"project_id": 9230,
"label_id": 5201,
"budget": null,
"required": true,
"updated_at": "2019-08-13T11:40:15+02:00"
},
{
"project_id": 9230,
"label_id": 5202,
"budget": null,
"required": true,
"updated_at": "2019-08-13T11:40:15+02:00"
},
{
"project_id": 9230,
"label_id": 5203,
"budget": null,
"required": false,
"updated_at": "2019-08-13T11:40:15+02:00"
},
{
"project_id": 9230,
"label_id": 5204,
"budget": null,
"required": false,
"updated_at": "2019-08-13T11:40:15+02:00"
}
],
"label_ids": [
5201,
5202,
5203,
5204
],
"required_label_ids": [
5201,
5202
],
"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": "2019-08-13T11:40:15+02:00"
}
}
Delete a project
Request
curl "https://api.timelyapp.com/1.1/11403/projects/9231" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Xh9PBvn7mjXG8LAcKRRQW21Tg4NnYTaZhLVlKp9Trxw" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/projects/:id
DELETE /1.1/11403/projects/9231
Accept: application/json
Content-Type: application/json
Authorization: Bearer Xh9PBvn7mjXG8LAcKRRQW21Tg4NnYTaZhLVlKp9Trxw
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which project to be deleted |
| id | The id of the project to be deleted |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all projects
Note: Normal user will get all the projects from account. Limited user will get only his projects.
Project list will return recently updated 10 projects additionally you can add the “per_page”, “filter” and “order” optional parameters to change the result.
Request
curl -g "https://api.timelyapp.com/1.1/11405/projects" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer HaAwQUVBmjZO7lgp5J1m1X5XEyZnjYGh5UDQEyr1VQg" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects
GET /1.1/11405/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer HaAwQUVBmjZO7lgp5J1m1X5XEyZnjYGh5UDQEyr1VQg
Parameters
| Name | Description |
|---|---|
| offset | Retrieve projects from offset |
| limit | Retrieve number of projects |
| order | Sorting order on updated_at |
| filter | Filter projects - mine, active, archived, all |
| updated_after | Retrieve records updated after a certain timestamp |
| project_ids | Retrieve specific projects |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 9233,
"active": true,
"account_id": 11405,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689217,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6928,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:17+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"users": [
{
"user_id": 26311,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2019-08-13T11:40:17+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 providing a project id.
Request
curl -g "https://api.timelyapp.com/1.1/11404/projects/9232" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer M4nCuHkUgDwfcg378Ct5XjEjYhiLOdfi3H90nKfw2bM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/projects/:id
GET /1.1/11404/projects/9232
Accept: application/json
Content-Type: application/json
Authorization: Bearer M4nCuHkUgDwfcg378Ct5XjEjYhiLOdfi3H90nKfw2bM
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which project to be retrieved |
| id | The id of the project to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 9232,
"active": true,
"account_id": 11404,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689217,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6927,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:17+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"users": [
{
"user_id": 26309,
"hour_rate": 100.0,
"hour_rate_in_cents": 10000.0,
"updated_at": "2019-08-13T11:40:17+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/11407/projects/9235" -d '{"project":{"name":"updated project name"}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 5gLdxU_mKvn9YJy3pksjAm9E-9XMQKDwbrIzwAmJA-I" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/projects/:id
PUT /1.1/11407/projects/9235
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5gLdxU_mKvn9YJy3pksjAm9E-9XMQKDwbrIzwAmJA-I
Parameters
{"project":{"name":"updated project name"}}
| Name | Description |
|---|---|
| id required | Project id |
| project | Project attributes |
| name required | Specifies the project name |
| color required | Specifies the project color, should be one of 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0 |
| client_id required | Specifies the numerical client id |
| users required | Specifies the project users, should be array of users with numerical user id and hour_rate Example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }] |
| billable | Specifies the project is billable or not, should be true or false |
| budget | Specifies the budget for project, should be numeric value |
| hour_rate | Specifies the hour rate for project, should be numeric value |
| rate_type | Specifies the hour rate type for project, should be 'user' or 'project' |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
| send_invite | Specifies if you want to send project invite email, should be true or false |
| required_notes | Project hours notes to be required for logging |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 9235,
"active": true,
"account_id": 11407,
"name": "updated project name",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689219,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6930,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:18+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.0,
"users": [
{
"user_id": 26315,
"hour_rate": 0.0,
"hour_rate_in_cents": 0.0,
"updated_at": "2019-08-13T11:40:19+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
Presenting adequate information on various aspects of the business, performance of you and your team. You can export it in excel, pdf and csv format.
All Report
Normal user accessing report for account.
Note:
1) If 'start_date' and 'end_date' parameters are not passed, default period is beginning of month to end of month.
2) if the 'users' and 'projects' parameters are not passed, default normal user will get all the report from account and limited user will get his report.
3) Only normal user can get report of other users of same account. Limited user will always get his report.
4) Only normal user can get report of other projects of same account. Limited user can only get report of his own project.
Request
curl "https://api.timelyapp.com/1.1/11437/reports" -d '{"user_ids":"26379","since":"2018-01-01","until":"2019-01-01","project_ids":"9292"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer PUjPNyjtpwc2cmrCMh50KJtz2UM1EaNON7AIj9Nsfxg" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/reports
POST /1.1/11437/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer PUjPNyjtpwc2cmrCMh50KJtz2UM1EaNON7AIj9Nsfxg
Parameters
{"user_ids":"26379","since":"2018-01-01","until":"2019-01-01","project_ids":"9292"}
| Name | Description |
|---|---|
| account_id | Account id for which report to be retrieved |
| user_ids | Specifies the users to get report, should be comma separated numerical user ids Example: "user_ids": "175551,117861" |
| since | Specifies the start date for report Example: "since" : "Jan 01, 2014" |
| until | Specifies the end date for report Example: "until" : "Dec 31, 2014" |
| project_ids | Specifies the projects to get report, should be comma separated numerical project ids Example: "project_ids": "1751,1171" |
| billed | Specifies the report type to retrive estimated or billed events. Example: "billed": false or "billed": true |
| label_ids | Specifies the labels to get report, should be comma separated numerical label ids Example: "label_ids": "751,117" |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 6960,
"name": "Timely",
"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
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"projects": [
{
"id": 9292,
"active": true,
"account_id": 11437,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689239,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6960,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:39+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.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
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
}
}
]
}
]
Filter Report
Use filter endpoint with parameters to limit the data returned so that you see only values that you need.
Request
curl "https://api.timelyapp.com1.1/11438/reports/filter" -d '{"user_ids":"26381","since":"2018-01-01","until":"2019-01-01","project_ids":"9293"}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer KJ_67fS0tx1x3c3sOQ5VFoNIqkZW0z3jNwJqr26NxVI" \
-H "Cookie: "
Endpoint
POST 1.1/:account_id/reports/filter
POST 1.1/11438/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer KJ_67fS0tx1x3c3sOQ5VFoNIqkZW0z3jNwJqr26NxVI
Parameters
{"user_ids":"26381","since":"2018-01-01","until":"2019-01-01","project_ids":"9293"}
| Name | Description |
|---|---|
| billed | Retrieve only billed hours. Example: billed=true |
| label_ids | Specifies the label ids to retrieve hours, should be array of numerical label ids Example: label_ids: [3, 4, 2] |
| project_ids | Specifies the project ids to retrieve hours, should be array of numerical project ids Example:project_ids: [3, 4, 2] |
| since | start date for report Example: 'since=2019-01-01' |
| team_ids | Specifies the team ids to retrieve hours, should be array of numerical team ids Example: team_ids: [3, 4, 2] |
| until | start date for report Example: 'since=2019-12-31' |
| user_ids | Specifies the user ids to retrieve hours, should be array of numerical user ids Example: user_ids: [3, 4, 2] |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"clients": [
{
"id": 6961,
"name": "Timely",
"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
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
},
"projects": [
{
"id": 9293,
"active": true,
"account_id": 11438,
"name": "Timely",
"color": "67a3bc",
"rate_type": "project",
"billable": true,
"updated_at": 1565689240,
"external_id": null,
"budget_scope": null,
"client": {
"id": 6961,
"name": "Timely",
"active": true,
"external_id": null,
"updated_at": "2019-08-13T11:40:40+02:00"
},
"required_notes": false,
"budget": 0,
"budget_type": "",
"hour_rate": 50.0,
"hour_rate_in_cents": 5000.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
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
}
}
]
}
],
"users": [
{
"id": 26381,
"email": "marijamzcogxgk@timelyapp.com",
"name": "Marija Petrovic",
"time_zone": "Europe/Paris",
"updated_at": 1565689239,
"active": false,
"deleted": false,
"memory_onboarded": true,
"day_view_onboarded": true,
"last_received_memories_date": null,
"default_hour_rate": 0.0,
"date_format": "dmy",
"time_format": "24",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/c2b5aab3e3c1d3331d9a7ac522ab7b1a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"large": "https://www.gravatar.com/avatar/c2b5aab3e3c1d3331d9a7ac522ab7b1a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large.jpg&s=",
"medium_retina": "https://www.gravatar.com/avatar/c2b5aab3e3c1d3331d9a7ac522ab7b1a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/c2b5aab3e3c1d3331d9a7ac522ab7b1a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium.jpg&s=",
"timeline": "https://www.gravatar.com/avatar/c2b5aab3e3c1d3331d9a7ac522ab7b1a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline.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
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.0
}
}
],
"labels": [
{
"id": 0,
"name": "Untagged",
"sequence": -1,
"parent_id": null,
"emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v2.4.4/img-twitter-64/1f3f7.png",
"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
},
"cost": {
"fractional": 25000,
"formatted": "$250.00",
"amount": 250.0
},
"estimated_cost": {
"fractional": 40000,
"formatted": "$400.00",
"amount": 400.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
},
"cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.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
},
"cost": {
"fractional": 12500,
"formatted": "$125.00",
"amount": 125.0
},
"estimated_cost": {
"fractional": 20000,
"formatted": "$200.00",
"amount": 200.0
}
}
]
}
Teams
Team object should show all teams available for the given account.
Create a team
Request
curl "https://api.timelyapp.com/1.1/11453/teams" -d '{"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":26411,"lead":true},{"user_id":26413,"lead":false}]}}' -X POST \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer cJK6oMD6qMEZt7tSYeTzK3fcDlH0REzNX_mO6XAHhBo" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/teams
POST /1.1/11453/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer cJK6oMD6qMEZt7tSYeTzK3fcDlH0REzNX_mO6XAHhBo
Parameters
{"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":26411,"lead":true},{"user_id":26413,"lead":false}]}}
| Name | Description |
|---|---|
| name required | Specifies the team name |
| emoji | Specifies the emoji url for team |
| color | Specifies the project color for team |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 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
201 Created
{
"id": 1076,
"name": "Timely",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
26411,
26413
],
"users": [
{
"id": 1446,
"user_id": 26411,
"team_id": 1076,
"lead": true
},
{
"id": 1447,
"user_id": 26413,
"team_id": 1076,
"lead": false
}
]
}
Delete a team
Request
curl "https://api.timelyapp.com/1.1/11454/teams/1077" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer JdqM-PK9QlufUag_bjHlLL-INsDaiRn-3KwZp0stgiY" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/teams/:id
DELETE /1.1/11454/teams/1077
Accept: application/json
Content-Type: application/json
Authorization: Bearer JdqM-PK9QlufUag_bjHlLL-INsDaiRn-3KwZp0stgiY
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which team to be deleted |
| id | The id of the team to be deleted |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all teams
Request
curl -g "https://api.timelyapp.com/1.1/11456/teams" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer JMZ5isKNT3aHn3x-Z7FBSz4mIQOZ3Ntwj2UmRvM9wzM" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams
GET /1.1/11456/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer JMZ5isKNT3aHn3x-Z7FBSz4mIQOZ3Ntwj2UmRvM9wzM
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
[
]
Retrieve a team
Request
curl -g "https://api.timelyapp.com/1.1/11455/teams/1078" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer znzvVNL6YAyoyNwh8Dx4J7UzzqeauRRnZakdLpTL9oU" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/teams/:id
GET /1.1/11455/teams/1078
Accept: application/json
Content-Type: application/json
Authorization: Bearer znzvVNL6YAyoyNwh8Dx4J7UzzqeauRRnZakdLpTL9oU
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which team to be retrieved |
| id | The id of the team to be retrieved |
| page | Page number (Default 1) |
| per_page | Records per page (Default 50) |
| order | Sorting order on name |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 1078,
"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/11457/teams/1079" -d '{"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":26420,"lead":true}]}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 7glS2LC8rH2qhv0wYf2tfHYFyltxVxrAa6sdjTZRibA" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/teams/:id
PUT /1.1/11457/teams/1079
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7glS2LC8rH2qhv0wYf2tfHYFyltxVxrAa6sdjTZRibA
Parameters
{"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":26420,"lead":true}]}}
| Name | Description |
|---|---|
| name required | Specifies the team name |
| emoji | Specifies the emoji url for team |
| color | Specifies the color for team |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 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": 1079,
"name": "Backend",
"color": "67a3bc",
"emoji": "http://path.to/emoji.png",
"external_id": null,
"user_ids": [
26420
],
"users": [
{
"id": 1448,
"user_id": 26420,
"team_id": 1079,
"lead": true
}
]
}
Users
Every account can have multiple users associated with it. All users created within one account have limited privileges. A user is usually created by an employer on behalf of the employee.
Create/Invite a user
Note: “user_level” can have values normal/limited. User name and email cannot be updated by anyone, only the user himself can do that.
Request
curl "https://api.timelyapp.com/1.1/11461/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":9316,"hour_rate":10}]},"admin":{"id":5844,"email":"notifications@timelyapp.com","created_at":"2019-08-13T11:40:50.000+02:00","updated_at":"2019-08-13T11:40:50.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 yIWbiLEgzcyVPoA2XWNwtsnZPcWLL00oJKFI0npWLbw" \
-H "Cookie: "
Endpoint
POST /1.1/:account_id/users
POST /1.1/11461/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer yIWbiLEgzcyVPoA2XWNwtsnZPcWLL00oJKFI0npWLbw
Parameters
{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":9316,"hour_rate":10}]},"admin":{"id":5844,"email":"notifications@timelyapp.com","created_at":"2019-08-13T11:40:50.000+02:00","updated_at":"2019-08-13T11:40:50.000+02:00","name":"Timely","notifier":false}}
| Name | Description |
|---|---|
| user required | Label attributes |
| name required | Specifies the user name |
| email required | Specifies the user email |
| projects | Specifies the projects that user will be part of Example"projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }] |
| user_level | Specifies the user level, should be normal/limited, default will be "normal" Example: "user_level": "normal" |
| admin | Specifies the user is admin, in this case user_level should be normal Example: "admin": "true" |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 26430,
"email": "marija@timely.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": false,
"memory_onboarded": false,
"created_at": 1565689250,
"updated_at": 1565689250,
"default_hour_rate": 0.0,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"large": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25",
"small": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25"
},
"user_level": "normal",
"admin": false,
"hide_hourly_rate": false,
"deleted": false
}
Delete a user
Request
curl "https://api.timelyapp.com/1.1/11462/users/26431" -d '' -X DELETE \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer zYfj5rxs2Z_umWqO5QfMbUSryBK1ODeyQDs9MunS82k" \
-H "Cookie: "
Endpoint
DELETE /1.1/:account_id/users/:id
DELETE /1.1/11462/users/26431
Accept: application/json
Content-Type: application/json
Authorization: Bearer zYfj5rxs2Z_umWqO5QfMbUSryBK1ODeyQDs9MunS82k
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which user to be deleted |
| id | The id of the user to be deleted |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
}
List all users
Note: User list will return recently updated 10 users.
Request
curl -g "https://api.timelyapp.com/1.1/11465/users" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer x5PkM3bu535Uyf2j3k7G9ydhpSwBGOtf-Z9-v0nDb7c" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users
GET /1.1/11465/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer x5PkM3bu535Uyf2j3k7G9ydhpSwBGOtf-Z9-v0nDb7c
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which users to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": 26437,
"email": "marijaxhiqhstu@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1565689252,
"updated_at": 1565689252,
"default_hour_rate": 0.0,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/171449a0afa274ac91907566d4e279fe?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"large": "https://www.gravatar.com/avatar/171449a0afa274ac91907566d4e279fe?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/171449a0afa274ac91907566d4e279fe?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/171449a0afa274ac91907566d4e279fe?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/171449a0afa274ac91907566d4e279fe?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25",
"small": "https://www.gravatar.com/avatar/171449a0afa274ac91907566d4e279fe?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25"
},
"user_level": "normal",
"admin": true,
"hide_hourly_rate": false,
"deleted": false
}
]
Retrieve a user
Request
curl -g "https://api.timelyapp.com/1.1/11463/users/26433" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer tYLOlfKo4IPPIpAk69YUDUDf6APZuE05LNDbb9u6YCE" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/:id
GET /1.1/11463/users/26433
Accept: application/json
Content-Type: application/json
Authorization: Bearer tYLOlfKo4IPPIpAk69YUDUDf6APZuE05LNDbb9u6YCE
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which user to be retrieved |
| id | The id of the user to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 26433,
"email": "marijahidgwaon@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1565689251,
"updated_at": 1565689251,
"default_hour_rate": 0.0,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/b1887dcb0411450294e75b1bdaaa644d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"large": "https://www.gravatar.com/avatar/b1887dcb0411450294e75b1bdaaa644d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/b1887dcb0411450294e75b1bdaaa644d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/b1887dcb0411450294e75b1bdaaa644d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/b1887dcb0411450294e75b1bdaaa644d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25",
"small": "https://www.gravatar.com/avatar/b1887dcb0411450294e75b1bdaaa644d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25"
},
"user_level": "normal",
"admin": true,
"hide_hourly_rate": false,
"deleted": false
}
Retrieve current user
Request
curl -g "https://api.timelyapp.com/1.1/11464/users/current" -X GET \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer NDPg2qJr8iNX67n0nU4BBxaoRFh5_qDZAZZhnr1HWM0" \
-H "Cookie: "
Endpoint
GET /1.1/:account_id/users/current
GET /1.1/11464/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer NDPg2qJr8iNX67n0nU4BBxaoRFh5_qDZAZZhnr1HWM0
Parameters
| Name | Description |
|---|---|
| account_id | Account id for which current user to be retrieved |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 26435,
"email": "marijaahwznfyt@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1565689252,
"updated_at": 1565689252,
"default_hour_rate": 0.0,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/5c53c74db5d79fa85a961763b4638971?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"large": "https://www.gravatar.com/avatar/5c53c74db5d79fa85a961763b4638971?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/5c53c74db5d79fa85a961763b4638971?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/5c53c74db5d79fa85a961763b4638971?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/5c53c74db5d79fa85a961763b4638971?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25",
"small": "https://www.gravatar.com/avatar/5c53c74db5d79fa85a961763b4638971?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25"
},
"user_level": "normal",
"admin": true,
"hide_hourly_rate": false,
"deleted": false
}
Update a user
Note:
All other parameters are as mention in create user.
Should not update “user_level” and “projects” as these fields are only editable by admin for other users.
Only admin user can update other users profile, limited user will only update self profile.
Request
curl "https://api.timelyapp.com/1.1/11466/users/26439" -d '{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":9321,"hour_rate":10}]},"admin":{"id":5849,"email":"notifications@timelyapp.com","created_at":"2019-08-13T11:40:53.000+02:00","updated_at":"2019-08-13T11:40:53.000+02:00","name":"Timely","notifier":false}}' -X PUT \
-H "Host: api.timelyapp.com" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer klyb5AA0WvSLlafDfvuMYlZ09gJM-M9c8q5WUdW9N9U" \
-H "Cookie: "
Endpoint
PUT /1.1/:account_id/users/:id
PUT /1.1/11466/users/26439
Accept: application/json
Content-Type: application/json
Authorization: Bearer klyb5AA0WvSLlafDfvuMYlZ09gJM-M9c8q5WUdW9N9U
Parameters
{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":9321,"hour_rate":10}]},"admin":{"id":5849,"email":"notifications@timelyapp.com","created_at":"2019-08-13T11:40:53.000+02:00","updated_at":"2019-08-13T11:40:53.000+02:00","name":"Timely","notifier":false}}
| Name | Description |
|---|---|
| id required | The numerical ID of the desired user. |
| user required | Label attributes |
| name required | Specifies the user name |
| email required | Specifies the user email |
| projects | Specifies the projects that user will be part of Example"projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }] |
| user_level | Specifies the user level, should be normal/limited, default will be "normal" Example: "user_level": "normal" |
| admin | Specifies the user is admin, in this case user_level should be normal Example: "admin": "true" |
| external_id | The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"id": 26439,
"email": "marijaaoscpkuz@timelyapp.com",
"name": "Marija Petrovic",
"active": false,
"day_view_onboarded": true,
"memory_onboarded": true,
"created_at": 1565689253,
"updated_at": 1565689253,
"default_hour_rate": 0.0,
"last_received_memories_date": null,
"sign_in_count": null,
"external_id": null,
"time_zone": "Europe/Paris",
"avatar": {
"large_retina": "https://www.gravatar.com/avatar/47f83f20d4c959feade65a94ec0051da?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"large": "https://www.gravatar.com/avatar/47f83f20d4c959feade65a94ec0051da?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina.jpg&s=200",
"medium_retina": "https://www.gravatar.com/avatar/47f83f20d4c959feade65a94ec0051da?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"medium": "https://www.gravatar.com/avatar/47f83f20d4c959feade65a94ec0051da?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina.jpg&s=50",
"small_retina": "https://www.gravatar.com/avatar/47f83f20d4c959feade65a94ec0051da?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25",
"small": "https://www.gravatar.com/avatar/47f83f20d4c959feade65a94ec0051da?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina.jpg&s=25"
},
"user_level": "normal",
"admin": false,
"hide_hourly_rate": false,
"deleted": false
}
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 given the information provided. Codes in the 5xx range indicate an error with Timely's servers.
Accessing unauthorized to another project, account, 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 | Access with wrong authentication token |
| 403 - Forbidden | The entity requested is hidden for unauthorized access |
| 404 - Not Found | The specified entity could not be found |
| 422 - Unprocessable Entity | Server understands the content type, but it was unable to process the request |
| 500 - Internal Server Error | We had a problem with our server. Try again later. |