NAV Navbar
cURL

Introduction

Welcome! This document provides a full list of all Timely APIs currently available, so you can start integrating Timely with your favorite applications.

Got questions? Please send them to support@timelyapp.com.

Authentication

OAuth2 Authentication: http://tools.ietf.org/html/rfc6749

Create an OAuth Application (only available to the Admin User): https://timelyapp.com/:account_id/oauth_applications

Enter your application name and the redirect_url to your application.

Acquire the Application Id and Secret.

The base URL for all API's is: https://api.timelyapp.com/1.1

Authorization

OAuth Code

Example Request: (try this in your web browser)
https://api.timelyapp.com/1.1/oauth/authorize?response_type=code
&redirect_uri=your_redirect_uri&client_id=your_client_id

Users are redirected to request their Timely identity.

HTTP Request

GET /oauth/authorize

Compulsory Parameters

Parameter Description
response_type code
redirect_uri http://your-redirect-url/
client_id your_application_id

If the user accepts your request, Timely will redirect back with the code parameter, which you need to use to get the token.

OAuth Token

Example Request:
curl -X POST --data "redirect_uri=https://your-redirect_url/&code=your_response_code
&client_id=application_id&client_secret=application_secret&grant_type=authorization_code"
https://api.timelyapp.com/1.1/oauth/token
{
  "access_token":"1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a",
  "token_type":"bearer",
  "refresh_token":"9db4d1a5d87c707b8125d8f93ad08091fb3ff8b93be901dbeaba968cf532ed9b"
}
200 OK

Users are redirected to request their Timely identity.

HTTP Request

POST /oauth/token

Compulsory Parameters

Parameter Description
redirect_uri http://your-redirect-url/
code your_response_code
client_id your_application_id
client_secret your_application_secret
grant_type authorization_code

The response will be a token with a refresh token. Use the token to use the following API.

Use Timely API to integrate with your apps

Timely API helps you integrate your application with Timely. Following are the list of API’s available. For any help or support email support@timelyapp.com

Accounts

List all accounts

Returns all the accounts created against one email address.

Request

curl -g "https://api.timelyapp.com/1.1/accounts" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer IZKcVdI6JmFoyF72eUt4YpJ9lZQ8czZUcIQWbil1wt0" \
    -H "Cookie: "

Endpoint

GET /1.1/accounts

GET /1.1/accounts
Accept: application/json
Content-Type: application/json
Authorization: Bearer IZKcVdI6JmFoyF72eUt4YpJ9lZQ8czZUcIQWbil1wt0

Parameters

None known.

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 922,
    "name": "Timely",
    "color": "44505e",
    "currency": {
      "id": "usd",
      "name": "United States Dollar",
      "iso_code": "USD",
      "symbol": "$",
      "symbol_first": true
    },
    "logo": {
      "large_retina": "/assets/account_thumbs/account_large_retina-8bc212c450af14b3a0ea49098cdddbe4f90d5eb5fc57adfeade6ac1ad8fb1d4a.png",
      "medium_retina": "/assets/account_thumbs/account_medium_retina-10dfbcc6733ccba1d485971f63c5eb7f9b7ed1a942a0ebd140e292bcb1e4dbea.png",
      "small_retina": "/assets/account_thumbs/account_small_retina-ea5df153b4cd96fc801e2361afc7d1b06d7b95ce5c358250b81149e1a20689df.png",
      "brand_logo": false
    },
    "from": "Web",
    "max_users": 0,
    "seats": 1,
    "max_projects": 0,
    "plan_id": 923,
    "plan_name": "Essential",
    "next_charge": "2021-03-11",
    "start_of_week": 0,
    "created_at": 1613018579,
    "payment_mode": "web",
    "paid": true,
    "company_size": "10-49",
    "plan_code": "essential",
    "plan_custom": false,
    "appstore_transaction_id": null,
    "owner_id": 2061,
    "weekly_user_capacity": 40.0,
    "default_hour_rate": 0.0,
    "support_email": "support@timelyapp.com",
    "estimated_company_size": null,
    "industry": null,
    "num_users": 1,
    "num_projects": 0,
    "active_projects_count": 0,
    "total_projects_count": 0,
    "capacity": {
      "hours": 40,
      "minutes": 0,
      "seconds": 0.0,
      "formatted": "40:00",
      "total_hours": 40.0,
      "total_seconds": 144000.0,
      "total_minutes": 2400.0
    },
    "status": "active",
    "beta": false,
    "expired": false,
    "trial": false,
    "days_to_end_trial": 0,
    "features": [
      {
        "name": "control",
        "days": -1
      },
      {
        "name": "memories",
        "days": -1
      },
      {
        "name": "billing",
        "days": -1
      },
      {
        "name": "project_required_fields",
        "days": -1
      },
      {
        "name": "teams",
        "days": -1
      },
      {
        "name": "recurring_budget",
        "days": -1
      },
      {
        "name": "notifications_project_budget",
        "days": -1
      },
      {
        "name": "weekly_user_capacity",
        "days": -1
      },
      {
        "name": "company_view",
        "days": -1
      },
      {
        "name": "anomalies",
        "days": -1
      },
      {
        "name": "log_hours_for_others",
        "days": -1
      },
      {
        "name": "project_budget",
        "days": -1
      },
      {
        "name": "budgets_hourly_rates",
        "days": -1
      },
      {
        "name": "account_branding",
        "days": -1
      },
      {
        "name": "team_lead",
        "days": -1
      },
      {
        "name": "ai_timesheet_creation",
        "days": -1
      },
      {
        "name": "in_app_support",
        "days": -1
      },
      {
        "name": "planning",
        "days": -1
      },
      {
        "name": "people_dashboard",
        "days": -1
      },
      {
        "name": "people_notify",
        "days": -1
      },
      {
        "name": "premium_integrations",
        "days": -1
      },
      {
        "name": "individual_capacity",
        "days": -1
      },
      {
        "name": "audits",
        "days": -1
      },
      {
        "name": "project_dashboard",
        "days": -1
      },
      {
        "name": "high_level_reports",
        "days": -1
      },
      {
        "name": "live_reports",
        "days": -1
      },
      {
        "name": "invoices",
        "days": -1
      }
    ]
  }
]

Retrieve activities

This endpoint shows you all activities tied to you and/or any other users you have permission to view. Activities include: logged hours, created a report, shared a report.

Request

curl -g "https://api.timelyapp.com/1.1/920/activities" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer J14LPje34fME_y4d35WvvqGxXfSUmdkrfiRIrOCuG1A" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/activities

GET /1.1/920/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer J14LPje34fME_y4d35WvvqGxXfSUmdkrfiRIrOCuG1A

Parameters

Name Description
account_id The ID of the account you want to retrieve
limit Retrieve a limited number of activities
offset Retrieve activities from offset
order Sorting order on created_at
filter Filter activities by entity_type - Ex: filter=projects

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 80,
    "user": {
      "id": 2056,
      "email": "marijaptheldsj@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
      },
      "updated_at": "2021-02-11T05:42:58+01:00"
    },
    "message": "archived",
    "activity_type": "archive_project",
    "url": "http://app.timelyapp.local:3002/920/projects/560",
    "updated_at": "2021-02-04T05:42:58+01:00",
    "detail": null,
    "associated_ids": [

    ],
    "entity_type": "Project",
    "entity_deleted": false,
    "parent_entity_name": "",
    "entity": {
      "id": 560,
      "active": true,
      "name": "Timely",
      "color": "67a3bc",
      "client": {
        "id": 629,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2021-02-11T05:42:58+01:00"
      },
      "updated_at": "2021-02-11T05:42:58+01:00"
    },
    "anomaly": false
  },
  {
    "id": 79,
    "user": {
      "id": 2056,
      "email": "marijaptheldsj@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/3c9c229cbd4de7c2ba94a6db9edbcc27?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
      },
      "updated_at": "2021-02-11T05:42:58+01:00"
    },
    "message": "50% of budget used",
    "activity_type": "project_budget_progress_fifty",
    "url": "http://app.timelyapp.local:3002/920/projects/560",
    "updated_at": "2021-02-11T05:42:58+01:00",
    "detail": null,
    "associated_ids": [

    ],
    "entity_type": "Project",
    "entity_deleted": false,
    "parent_entity_name": "",
    "entity": {
      "id": 560,
      "active": true,
      "name": "Timely",
      "color": "67a3bc",
      "client": {
        "id": 629,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2021-02-11T05:42:58+01:00"
      },
      "updated_at": "2021-02-11T05:42:58+01:00"
    },
    "anomaly": false
  }
]

Retrieve an account

Returns one account object related to one company and one subscription plan.

Request

curl -g "https://api.timelyapp.com/1.1/accounts/921" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer V4pefEknwvzAdJ9ADaFvyOU0GD-CFi-PKlZlT5ScA2E" \
    -H "Cookie: "

Endpoint

GET /1.1/accounts/:id

GET /1.1/accounts/921
Accept: application/json
Content-Type: application/json
Authorization: Bearer V4pefEknwvzAdJ9ADaFvyOU0GD-CFi-PKlZlT5ScA2E

Parameters

Name Description
id The id of the account to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 921,
  "name": "Timely",
  "color": "44505e",
  "currency": {
    "id": "usd",
    "name": "United States Dollar",
    "iso_code": "USD",
    "symbol": "$",
    "symbol_first": true
  },
  "logo": {
    "large_retina": "/assets/account_thumbs/account_large_retina-8bc212c450af14b3a0ea49098cdddbe4f90d5eb5fc57adfeade6ac1ad8fb1d4a.png",
    "medium_retina": "/assets/account_thumbs/account_medium_retina-10dfbcc6733ccba1d485971f63c5eb7f9b7ed1a942a0ebd140e292bcb1e4dbea.png",
    "small_retina": "/assets/account_thumbs/account_small_retina-ea5df153b4cd96fc801e2361afc7d1b06d7b95ce5c358250b81149e1a20689df.png",
    "brand_logo": false
  },
  "from": "Web",
  "max_users": 0,
  "seats": 1,
  "max_projects": 0,
  "plan_id": 922,
  "plan_name": "Essential",
  "next_charge": "2021-03-11",
  "start_of_week": 0,
  "created_at": 1613018578,
  "payment_mode": "web",
  "paid": true,
  "company_size": "10-49",
  "plan_code": "essential",
  "plan_custom": false,
  "appstore_transaction_id": null,
  "owner_id": 2059,
  "weekly_user_capacity": 40.0,
  "default_hour_rate": 0.0,
  "support_email": "support@timelyapp.com",
  "estimated_company_size": null,
  "industry": null,
  "num_users": 1,
  "num_projects": 0,
  "active_projects_count": 0,
  "total_projects_count": 0,
  "capacity": {
    "hours": 40,
    "minutes": 0,
    "seconds": 0.0,
    "formatted": "40:00",
    "total_hours": 40.0,
    "total_seconds": 144000.0,
    "total_minutes": 2400.0
  },
  "status": "active",
  "beta": false,
  "expired": false,
  "trial": false,
  "days_to_end_trial": 0,
  "features": [
    {
      "name": "control",
      "days": -1
    },
    {
      "name": "memories",
      "days": -1
    },
    {
      "name": "billing",
      "days": -1
    },
    {
      "name": "project_required_fields",
      "days": -1
    },
    {
      "name": "teams",
      "days": -1
    },
    {
      "name": "recurring_budget",
      "days": -1
    },
    {
      "name": "notifications_project_budget",
      "days": -1
    },
    {
      "name": "weekly_user_capacity",
      "days": -1
    },
    {
      "name": "company_view",
      "days": -1
    },
    {
      "name": "anomalies",
      "days": -1
    },
    {
      "name": "log_hours_for_others",
      "days": -1
    },
    {
      "name": "project_budget",
      "days": -1
    },
    {
      "name": "budgets_hourly_rates",
      "days": -1
    },
    {
      "name": "account_branding",
      "days": -1
    },
    {
      "name": "team_lead",
      "days": -1
    },
    {
      "name": "ai_timesheet_creation",
      "days": -1
    },
    {
      "name": "in_app_support",
      "days": -1
    },
    {
      "name": "planning",
      "days": -1
    },
    {
      "name": "people_dashboard",
      "days": -1
    },
    {
      "name": "people_notify",
      "days": -1
    },
    {
      "name": "premium_integrations",
      "days": -1
    },
    {
      "name": "individual_capacity",
      "days": -1
    },
    {
      "name": "audits",
      "days": -1
    },
    {
      "name": "project_dashboard",
      "days": -1
    },
    {
      "name": "high_level_reports",
      "days": -1
    },
    {
      "name": "live_reports",
      "days": -1
    },
    {
      "name": "invoices",
      "days": -1
    }
  ]
}

Clients

Clients are the companies that you work for. An account can have multiple clients.

Create a client

This API lets you create a client for an account.

Request

curl "https://api.timelyapp.com/1.1/944/clients" -d '{"name":null,"client":{"name":"Timely","active":true,"external_id":null}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer d243Ett3xo7goh7k_EmYUnq4y_760J40N99qGYpzpLw" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/clients

POST /1.1/944/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer d243Ett3xo7goh7k_EmYUnq4y_760J40N99qGYpzpLw

Parameters

{"name":null,"client":{"name":"Timely","active":true,"external_id":null}}
Name Description
name required Specifies the client name
active Example values: "true" or "false". Using "false" changes the client state to "archived"
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 645,
  "name": "Timely",
  "active": true,
  "external_id": null,
  "updated_at": "2021-02-11T05:43:10+01:00"
}

List all clients

Client lists will return your 10 most recently updated clients. Additionally, you can add the “per_page”, “filter” and “order” optional parameters to change the result

NOTE: Client list will return recently updated 10 clients.

Request

curl -g "https://api.timelyapp.com/1.1/945/clients" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Fe-Ueo68Bmy4UCqpUjqOs8jJm0LGcMbw-sPZv7iqXLM" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/clients

GET /1.1/945/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer Fe-Ueo68Bmy4UCqpUjqOs8jJm0LGcMbw-sPZv7iqXLM

Parameters

Name Description
account_id Account ID for the clients you want to retrieve
offset Retrieve clients from offset
limit Retrieve number of clients
show Specifies which records to retrieve. The default shows a current account’s active clients (show=active). Example: "show=all" or "show=active" or "show=archived"

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 646,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2021-02-11T05:43:10+01:00",
    "external_references": [

    ]
  }
]

Update a client

Update client details just by using a client’s ID.

Request

curl "https://api.timelyapp.com/1.1/946/clients/647" -d '{"name":null,"client":{"name":"Updated name","active":true}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer EXNWirLij6hdfD4kSZR2nWgakM8MT4ez5dJyGsnP_8M" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/clients/:id

PUT /1.1/946/clients/647
Accept: application/json
Content-Type: application/json
Authorization: Bearer EXNWirLij6hdfD4kSZR2nWgakM8MT4ez5dJyGsnP_8M

Parameters

{"name":null,"client":{"name":"Updated name","active":true}}
Name Description
id required Client ID
name required Specifies the client name
active Example values: “true” or “false”. Using “false” changes the client state to “archived”
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 647,
  "name": "Updated name",
  "active": true,
  "external_id": null,
  "updated_at": "2021-02-11T05:43:11+01:00"
}

Events

Events are all the entries a user makes. Users can add, delete and edit all entries. Some user’s actions are restricted based on their access level in Timely.

Create an event

When a user creates an event on their own timesheet.

Note: By default, the event is created for a user’s first active project, or the project they last logged time to.

Request

curl "https://api.timelyapp.com/1.1/964/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-02-11T05:43:18.052+01:00","to":"2021-02-11T09:13:18.052+01:00","day":"2021-02-11","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":583}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer GQtGq-zjQuI2fMgQDjEHCzLqtPuVVEvqhLRRLyWZXwk" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/events

POST /1.1/964/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer GQtGq-zjQuI2fMgQDjEHCzLqtPuVVEvqhLRRLyWZXwk

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-02-11T05:43:18.052+01:00","to":"2021-02-11T09:13:18.052+01:00","day":"2021-02-11","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":583}}
Name Description
day required Event day
hours required Event hours
minutes required Event minutes
estimated_minutes Specifies estimated minutes for an event. Example values: 0-60
estimated_hours Specifies estimated hours for an event. Example values: 0-12
note Specifies notes for an event
from Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30"
to Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30"
label_ids Specifies label IDs for an event. Example values: label_ids:[2,3,4]
project_id Specifies the project ID for an event
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 643,
  "uid": "9b698eb3105bd82528f23d0c92dedfc0",
  "user": {
    "id": 2150,
    "email": "marijabwfnjxfc@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/a978b93b6aa81113ee6500aca972c0d3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/a978b93b6aa81113ee6500aca972c0d3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/a978b93b6aa81113ee6500aca972c0d3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/a978b93b6aa81113ee6500aca972c0d3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/a978b93b6aa81113ee6500aca972c0d3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:17+01:00"
  },
  "project": {
    "id": 583,
    "active": true,
    "account_id": 964,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018598,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 653,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:18+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "cost": {
    "fractional": 17500,
    "formatted": "$175.00",
    "amount": 175.0
  },
  "estimated_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "day": "2021-02-11",
  "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": 1613018598,
  "created_at": 1613018598,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:18+01:00",
  "from": "2021-02-11T05:43:18+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 2150,
  "updater_id": 2150,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Create an event for a project

Note: Normal user can add hours to existing projects from account. Limited user can add hours to only his projects.

Request

curl "https://api.timelyapp.com/1.1/963/projects/582/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-02-11T05:43:17.512+01:00","to":"2021-02-11T09:13:17.512+01:00","day":"2021-02-11","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":582}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer PM4iQVQP2gJUm0EOBGfZlqibyN1EamdclfMomAq4sNU" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/projects/:project_id/events

POST /1.1/963/projects/582/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer PM4iQVQP2gJUm0EOBGfZlqibyN1EamdclfMomAq4sNU

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-02-11T05:43:17.512+01:00","to":"2021-02-11T09:13:17.512+01:00","day":"2021-02-11","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":582}}
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": 642,
  "uid": "291597a100aadd814d197af4f4bab3a7",
  "user": {
    "id": 2148,
    "email": "marijasdfbosra@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/044f4236459643ed6d227f63aa1dc34c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/044f4236459643ed6d227f63aa1dc34c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/044f4236459643ed6d227f63aa1dc34c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/044f4236459643ed6d227f63aa1dc34c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/044f4236459643ed6d227f63aa1dc34c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:16+01:00"
  },
  "project": {
    "id": 582,
    "active": true,
    "account_id": 963,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018597,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 652,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:17+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "cost": {
    "fractional": 17500,
    "formatted": "$175.00",
    "amount": 175.0
  },
  "estimated_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "day": "2021-02-11",
  "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": 1613018597,
  "created_at": 1613018597,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:17+01:00",
  "from": "2021-02-11T05:43:17+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 2148,
  "updater_id": 2148,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Create an event for another user

Note: Normal users can add hours for any user. If a project_id is not provided, the event is created against a user’s first active project, or the project they logged an event to in the last hour.

Request

curl "https://api.timelyapp.com/1.1/962/users/2146/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-02-11T05:43:16.806+01:00","to":"2021-02-11T09:13:16.806+01:00","day":"2021-02-11","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":2146}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 9clxsx3iSrUqR3ZUmGeIqFodBkvFWp5PTQmyY_3wtZ4" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/users/:user_id/events

POST /1.1/962/users/2146/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 9clxsx3iSrUqR3ZUmGeIqFodBkvFWp5PTQmyY_3wtZ4

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2021-02-11T05:43:16.806+01:00","to":"2021-02-11T09:13:16.806+01:00","day":"2021-02-11","note":"Notes for testing with some random #hash in it.","hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":2146}}
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": 641,
  "uid": "67e103b0761e60683e83c559be18d40c",
  "user": {
    "id": 2146,
    "email": "marijazombxosa@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/d7b55b03441309686dea7bb2dfe222ac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/d7b55b03441309686dea7bb2dfe222ac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/d7b55b03441309686dea7bb2dfe222ac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/d7b55b03441309686dea7bb2dfe222ac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/d7b55b03441309686dea7bb2dfe222ac?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:16+01:00"
  },
  "project": {
    "id": 581,
    "active": true,
    "account_id": 962,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018596,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 651,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:16+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "cost": {
    "fractional": 17500,
    "formatted": "$175.00",
    "amount": 175.0
  },
  "estimated_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "day": "2021-02-11",
  "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": 1613018596,
  "created_at": 1613018596,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:16+01:00",
  "from": "2021-02-11T05:43:16+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 2146,
  "updater_id": 2146,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Delete an event

Note: Normal users can delete events logged to other projects by other users on an account. Limited users can only delete their own events.

Request

curl "https://api.timelyapp.com/1.1/965/events/644" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer xkFDqYLVb7M4wakakXg5l-y2yfo2cCAu-WKIEVzAZrY" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/events/:id

DELETE /1.1/965/events/644
Accept: application/json
Content-Type: application/json
Authorization: Bearer xkFDqYLVb7M4wakakXg5l-y2yfo2cCAu-WKIEVzAZrY

Parameters

Name Description
account_id The account ID containing the hour you want to delete
id required The ID for the hour you want to delete

Response

Content-Type: application/json; charset=utf-8
200 OK
{
}

List all events

Get all events linked to active projects on a user’s account.

Note: If “filter” param is not passed, the default returns current users's logged events, filter=planned returns planned events and filter=all returns logged and planned events.

Request

curl -g "https://api.timelyapp.com/1.1/969/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer _AL23VWR0V7BfmBLUu0QxHt6ANFINaG0EFJa913cc68" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/events

GET /1.1/969/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer _AL23VWR0V7BfmBLUu0QxHt6ANFINaG0EFJa913cc68

Parameters

Name Description
account_id The account ID containing the hours you want to retrieve
since Specifies the start date for returned results. Example: since=2014-08-18
upto Specifies the end date for returned results. Example: upto=2014-08-24
day Specifies the day date for returned results. Example: day=2014-08-24
filter Specifies which records to retrieve (Default logged). Example: filter=logged or filter=planned or filter=all

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 648,
    "uid": "443cb001c138b2561a0d90720d6ce111",
    "user": {
      "id": 2160,
      "email": "marijaoshyjsww@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/5d8ead1dff79853b05d1c7c23afe3399?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/5d8ead1dff79853b05d1c7c23afe3399?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/5d8ead1dff79853b05d1c7c23afe3399?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/5d8ead1dff79853b05d1c7c23afe3399?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/5d8ead1dff79853b05d1c7c23afe3399?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
      },
      "updated_at": "2021-02-11T05:43:20+01:00"
    },
    "project": {
      "id": 588,
      "active": true,
      "account_id": 969,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1613018600,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 658,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2021-02-11T05:43:20+01:00"
      },
      "required_notes": false,
      "budget_expired_on": null,
      "has_recurrence": false,
      "enable_labels": "all",
      "budget": 0,
      "budget_type": "",
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "budget_progress": 0.0,
      "budget_percent": 0.0,
      "labels": [

      ],
      "label_ids": [

      ],
      "required_label_ids": [

      ]
    },
    "duration": {
      "hours": 3,
      "minutes": 30,
      "seconds": 0,
      "formatted": "03:30",
      "total_hours": 3.5,
      "total_seconds": 12600,
      "total_minutes": 210
    },
    "estimated_duration": {
      "hours": 4,
      "minutes": 0,
      "seconds": 0,
      "formatted": "04:00",
      "total_hours": 4.0,
      "total_seconds": 14400,
      "total_minutes": 240
    },
    "cost": {
      "fractional": 17500,
      "formatted": "$175.00",
      "amount": 175.0
    },
    "estimated_cost": {
      "fractional": 20000,
      "formatted": "$200.00",
      "amount": 200.0
    },
    "day": "2021-02-11",
    "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": 1613018600,
    "created_at": 1613018600,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2021-02-11T09:13:20+01:00",
    "from": "2021-02-11T05:43:20+01:00",
    "deleted": false,
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "creator_id": null,
    "updater_id": null,
    "external_id": null,
    "entry_ids": [

    ],
    "suggestion_id": null,
    "draft": false,
    "manage": true,
    "locked_reason": null,
    "locked": false,
    "invoice_id": null,
    "timestamps": [

    ]
  }
]

List all events for a project

Note: Normal users can access events logged to all projects on an account. Limited users can only access events in projects they belong to.

Request

curl -g "https://api.timelyapp.com/1.1/971/projects/590/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ZGmyXHvtdMGgNMpij1ekFTJb5rXIpS0sCXUQpAEyrG4" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/projects/:project_id/events

GET /1.1/971/projects/590/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer ZGmyXHvtdMGgNMpij1ekFTJb5rXIpS0sCXUQpAEyrG4

Parameters

Name Description
account_id The account ID containing the hours you want to retrieve
project_id The project ID for the hours you want to retrieve
since Specifies the start date for returned results. Example: since=2014-08-18
upto Specifies the end date for returned results. Example: upto=2014-08-24
day Specifies the day date for returned results. Example: day=2014-08-24

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 650,
    "uid": "884d247c6f65a96a7da4d1105d584ddd",
    "user": {
      "id": 2164,
      "email": "marijanjzttsuv@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/99b3fe2c2b2330993d42af291dc45f4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/99b3fe2c2b2330993d42af291dc45f4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/99b3fe2c2b2330993d42af291dc45f4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/99b3fe2c2b2330993d42af291dc45f4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/99b3fe2c2b2330993d42af291dc45f4f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
      },
      "updated_at": "2021-02-11T05:43:21+01:00"
    },
    "project": {
      "id": 590,
      "active": true,
      "account_id": 971,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1613018601,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 660,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2021-02-11T05:43:21+01:00"
      },
      "required_notes": false,
      "budget_expired_on": null,
      "has_recurrence": false,
      "enable_labels": "all",
      "budget": 0,
      "budget_type": "",
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "budget_progress": 0.0,
      "budget_percent": 0.0,
      "labels": [

      ],
      "label_ids": [

      ],
      "required_label_ids": [

      ]
    },
    "duration": {
      "hours": 3,
      "minutes": 30,
      "seconds": 0,
      "formatted": "03:30",
      "total_hours": 3.5,
      "total_seconds": 12600,
      "total_minutes": 210
    },
    "estimated_duration": {
      "hours": 4,
      "minutes": 0,
      "seconds": 0,
      "formatted": "04:00",
      "total_hours": 4.0,
      "total_seconds": 14400,
      "total_minutes": 240
    },
    "cost": {
      "fractional": 17500,
      "formatted": "$175.00",
      "amount": 175.0
    },
    "estimated_cost": {
      "fractional": 20000,
      "formatted": "$200.00",
      "amount": 200.0
    },
    "day": "2021-02-11",
    "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": 1613018601,
    "created_at": 1613018601,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2021-02-11T09:13:21+01:00",
    "from": "2021-02-11T05:43:21+01:00",
    "deleted": false,
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "creator_id": null,
    "updater_id": null,
    "external_id": null,
    "entry_ids": [

    ],
    "suggestion_id": null,
    "draft": false,
    "manage": true,
    "locked_reason": null,
    "locked": false,
    "invoice_id": null,
    "timestamps": [

    ]
  }
]

List all events for a user

Note: Normal users can access events logged by other users on an account. Limited users can only access their own logged events.

Request

curl -g "https://api.timelyapp.com/1.1/970/users/2162/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer x8pmIiFcQoQccAIZK_3kkbvNH0gXjVzcMBamgZwL-DE" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/:user_id/events

GET /1.1/970/users/2162/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer x8pmIiFcQoQccAIZK_3kkbvNH0gXjVzcMBamgZwL-DE

Parameters

Name Description
account_id The account ID containing the hours you want to retrieve
user_id The user ID for the hours you want to retrieve
since Specifies the start date for returned results. Example: since=2014-08-18
upto Specifies the end date for returned results. Example: upto=2014-08-24
day Specifies the day date for returned results. Example: day=2014-08-24

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 649,
    "uid": "55b37c5c270e5d84c793e486d798c01d",
    "user": {
      "id": 2162,
      "email": "marijagvvwmcwy@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/7b928aac149ba77c5aeff024d272dfaa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/7b928aac149ba77c5aeff024d272dfaa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/7b928aac149ba77c5aeff024d272dfaa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/7b928aac149ba77c5aeff024d272dfaa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/7b928aac149ba77c5aeff024d272dfaa?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
      },
      "updated_at": "2021-02-11T05:43:20+01:00"
    },
    "project": {
      "id": 589,
      "active": true,
      "account_id": 970,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1613018601,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 659,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2021-02-11T05:43:21+01:00"
      },
      "required_notes": false,
      "budget_expired_on": null,
      "has_recurrence": false,
      "enable_labels": "all",
      "budget": 0,
      "budget_type": "",
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "budget_progress": 0.0,
      "budget_percent": 0.0,
      "labels": [

      ],
      "label_ids": [

      ],
      "required_label_ids": [

      ]
    },
    "duration": {
      "hours": 3,
      "minutes": 30,
      "seconds": 0,
      "formatted": "03:30",
      "total_hours": 3.5,
      "total_seconds": 12600,
      "total_minutes": 210
    },
    "estimated_duration": {
      "hours": 4,
      "minutes": 0,
      "seconds": 0,
      "formatted": "04:00",
      "total_hours": 4.0,
      "total_seconds": 14400,
      "total_minutes": 240
    },
    "cost": {
      "fractional": 17500,
      "formatted": "$175.00",
      "amount": 175.0
    },
    "estimated_cost": {
      "fractional": 20000,
      "formatted": "$200.00",
      "amount": 200.0
    },
    "day": "2021-02-11",
    "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": 1613018601,
    "created_at": 1613018601,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2021-02-11T09:13:21+01:00",
    "from": "2021-02-11T05:43:21+01:00",
    "deleted": false,
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "creator_id": null,
    "updater_id": null,
    "external_id": null,
    "entry_ids": [

    ],
    "suggestion_id": null,
    "draft": false,
    "manage": true,
    "locked_reason": null,
    "locked": false,
    "invoice_id": null,
    "timestamps": [

    ]
  }
]

Logged in user updating details and user of an event

Note: Normal users can change an event’s creator to another user on their account. Limited users cannot edit event details.

Request

curl "https://api.timelyapp.com/1.1/976/users/2174/events/655" -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 u_xs2uDsqft2eebYce-IgjNnQomkSsBw65T2ipctpMc" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/users/:user_id/events/:id

PUT /1.1/976/users/2174/events/655
Accept: application/json
Content-Type: application/json
Authorization: Bearer u_xs2uDsqft2eebYce-IgjNnQomkSsBw65T2ipctpMc

Parameters

{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
Name Description
id required Event ID
day required Event day
hours required Event hours
minutes required Event minutes
estimated_minutes Specifies estimated minutes for an event. Example values: 0-60
estimated_hours Specifies estimated hours for an event. Example values: 0-12
note Specifies notes for an event
from Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30"
to Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30"
label_ids Specifies label IDs for an event. Example values: label_ids:[2,3,4]
project_id Specifies the project ID for an event
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 655,
  "uid": "3d2d8ccb37df977cb6d9da15b76c3f3a",
  "user": {
    "id": 2174,
    "email": "marijaswmcxuqg@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/133970a2ead48df270861c6e2b3e3e8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/133970a2ead48df270861c6e2b3e3e8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/133970a2ead48df270861c6e2b3e3e8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/133970a2ead48df270861c6e2b3e3e8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/133970a2ead48df270861c6e2b3e3e8c?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:24+01:00"
  },
  "project": {
    "id": 595,
    "active": true,
    "account_id": 976,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018604,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 665,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:24+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 4,
    "minutes": 0,
    "seconds": 0,
    "formatted": "04:00",
    "total_hours": 4.0,
    "total_seconds": 14400,
    "total_minutes": 240
  },
  "cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "estimated_cost": {
    "fractional": 20000,
    "formatted": "$200.00",
    "amount": 200.0
  },
  "day": "2021-02-11",
  "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": 1613018604,
  "created_at": 1613018604,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:24+01:00",
  "from": "2021-02-11T05:43:24+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 2174,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Loggedin user updating details and project of their event

Request

curl "https://api.timelyapp.com/1.1/975/projects/594/events/654" -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 qNBjkZjvwP2nRoKwIwYsynwlFO-7Ks8JPJW2KzeBbeY" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/projects/:project_id/events/:id

PUT /1.1/975/projects/594/events/654
Accept: application/json
Content-Type: application/json
Authorization: Bearer qNBjkZjvwP2nRoKwIwYsynwlFO-7Ks8JPJW2KzeBbeY

Parameters

{"event":{"note":"Updated details and project","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
Name Description
id required Event ID
project_id required Project ID
day required Event day
hours required Event hours
minutes required Event minutes
estimated_minutes Specifies estimated minutes for an event. Example values: 0-60
estimated_hours Specifies estimated hours for an event. Example values: 0-12
note Specifies notes for an event
from Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30"
to Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30"
label_ids Specifies label IDs for an event. Example values: label_ids:[2,3,4]
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 654,
  "uid": "ab233b682ec355648e7891e66c54191b",
  "user": {
    "id": 2172,
    "email": "marijazgnybvyz@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/b0bf3ab4a3a994ae55a098a37d5639c8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/b0bf3ab4a3a994ae55a098a37d5639c8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/b0bf3ab4a3a994ae55a098a37d5639c8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/b0bf3ab4a3a994ae55a098a37d5639c8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/b0bf3ab4a3a994ae55a098a37d5639c8?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:23+01:00"
  },
  "project": {
    "id": 594,
    "active": true,
    "account_id": 975,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018604,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 664,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:24+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 4,
    "minutes": 0,
    "seconds": 0,
    "formatted": "04:00",
    "total_hours": 4.0,
    "total_seconds": 14400,
    "total_minutes": 240
  },
  "cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "estimated_cost": {
    "fractional": 20000,
    "formatted": "$200.00",
    "amount": 200.0
  },
  "day": "2021-02-11",
  "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": 1613018604,
  "created_at": 1613018604,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:24+01:00",
  "from": "2021-02-11T05:43:24+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 2172,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Retrieve an event

Request

curl -g "https://api.timelyapp.com/1.1/968/events/647" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer dmpxTjtXx6agDqOlFmDOqCVbEPGeIVDFRzis__TkpHw" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/events/:id

GET /1.1/968/events/647
Accept: application/json
Content-Type: application/json
Authorization: Bearer dmpxTjtXx6agDqOlFmDOqCVbEPGeIVDFRzis__TkpHw

Parameters

Name Description
account_id The account ID containing the hour you want to retrieve
id The ID of the hour you want to retrieve

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 647,
  "uid": "303ed4c69846ab36c2904d3ba8573050",
  "user": {
    "id": 2158,
    "email": "marijaibogpynj@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/e0e280974cc0da8b19f63a7185ccf237?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/e0e280974cc0da8b19f63a7185ccf237?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/e0e280974cc0da8b19f63a7185ccf237?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/e0e280974cc0da8b19f63a7185ccf237?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/e0e280974cc0da8b19f63a7185ccf237?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:19+01:00"
  },
  "project": {
    "id": 587,
    "active": true,
    "account_id": 968,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018600,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 657,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:20+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 4,
    "minutes": 0,
    "seconds": 0,
    "formatted": "04:00",
    "total_hours": 4.0,
    "total_seconds": 14400,
    "total_minutes": 240
  },
  "cost": {
    "fractional": 17500,
    "formatted": "$175.00",
    "amount": 175.0
  },
  "estimated_cost": {
    "fractional": 20000,
    "formatted": "$200.00",
    "amount": 200.0
  },
  "day": "2021-02-11",
  "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": 1613018600,
  "created_at": 1613018600,
  "created_from": "Web",
  "updated_from": "Web",
  "billed": false,
  "to": "2021-02-11T09:13:20+01:00",
  "from": "2021-02-11T05:43:20+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": null,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Start timer on an event

Request

curl "https://api.timelyapp.com/1.1/972/events/651/start" -d '' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer z6cm3cFjb6nb0WuU2mVPNskz4wzQNrqt-z1OzUZE1yg" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/events/:id/start

PUT /1.1/972/events/651/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer z6cm3cFjb6nb0WuU2mVPNskz4wzQNrqt-z1OzUZE1yg

Parameters

Name Description
id required Event ID

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 651,
  "uid": "55743cc0393b1cb4b8b37d09ae48d097",
  "user": {
    "id": 2166,
    "email": "marijaavtiqrnl@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/6a7564b8d10fc9e85752d719449b0ab9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/6a7564b8d10fc9e85752d719449b0ab9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/6a7564b8d10fc9e85752d719449b0ab9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/6a7564b8d10fc9e85752d719449b0ab9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/6a7564b8d10fc9e85752d719449b0ab9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:22+01:00"
  },
  "project": {
    "id": 591,
    "active": true,
    "account_id": 972,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018602,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 661,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:22+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 4,
    "minutes": 0,
    "seconds": 0,
    "formatted": "04:00",
    "total_hours": 4.0,
    "total_seconds": 14400,
    "total_minutes": 240
  },
  "cost": {
    "fractional": 17500,
    "formatted": "$175.00",
    "amount": 175.0
  },
  "estimated_cost": {
    "fractional": 20000,
    "formatted": "$200.00",
    "amount": 200.0
  },
  "day": "2021-02-11",
  "note": "Notes for testing with some random #hash in it.",
  "sequence": 1,
  "estimated": false,
  "timer_state": "start",
  "timer_started_on": 1613018602,
  "timer_stopped_on": 0,
  "label_ids": [

  ],
  "user_ids": [

  ],
  "updated_at": 1613018602,
  "created_at": 1613018602,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:22+01:00",
  "from": "2021-02-11T05:43:22+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 2166,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Stop timer on an event

Request

curl "https://api.timelyapp.com/1.1/973/events/652/stop" -d '' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer _fhr1zk_zoSWtXRKYpwb6WDP4ufU7w8KQO8XjQxb3_U" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/events/:id/stop

PUT /1.1/973/events/652/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer _fhr1zk_zoSWtXRKYpwb6WDP4ufU7w8KQO8XjQxb3_U

Parameters

Name Description
id required Event ID

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 652,
  "uid": "30ef30b64204a3088a26bc2e6ecf7602",
  "user": {
    "id": 2168,
    "email": "marijasfrbqtqu@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/95ab4372d448fc2c997788e184da7aab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/95ab4372d448fc2c997788e184da7aab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/95ab4372d448fc2c997788e184da7aab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/95ab4372d448fc2c997788e184da7aab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/95ab4372d448fc2c997788e184da7aab?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:22+01:00"
  },
  "project": {
    "id": 592,
    "active": true,
    "account_id": 973,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018603,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 662,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:23+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 4,
    "minutes": 30,
    "seconds": 0,
    "formatted": "04:30",
    "total_hours": 4.5,
    "total_seconds": 16200,
    "total_minutes": 270
  },
  "estimated_duration": {
    "hours": 4,
    "minutes": 0,
    "seconds": 0,
    "formatted": "04:00",
    "total_hours": 4.0,
    "total_seconds": 14400,
    "total_minutes": 240
  },
  "cost": {
    "fractional": 22500,
    "formatted": "$225.00",
    "amount": 225.0
  },
  "estimated_cost": {
    "fractional": 20000,
    "formatted": "$200.00",
    "amount": 200.0
  },
  "day": "2021-02-11",
  "note": "Notes for testing with some random #hash in it.",
  "sequence": 1,
  "estimated": false,
  "timer_state": "stop",
  "timer_started_on": 0,
  "timer_stopped_on": 1613018603,
  "label_ids": [

  ],
  "user_ids": [

  ],
  "updated_at": 1613018603,
  "created_at": 1613018603,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:23+01:00",
  "from": "2021-02-11T05:43:23+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 2168,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Update an event

Note: Normal users can edit the project_id and events created by other users on their account. Limited users can only edit their own events.

Request

curl "https://api.timelyapp.com/1.1/974/events/653" -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 d0tKoSKK2mL5Q7HoGTsqT2bfluvXrkMMEoKkW7p2l34" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/events/:id

PUT /1.1/974/events/653
Accept: application/json
Content-Type: application/json
Authorization: Bearer d0tKoSKK2mL5Q7HoGTsqT2bfluvXrkMMEoKkW7p2l34

Parameters

{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
Name Description
id required Event ID
day required Event day
hours required Event hours
minutes required Event minutes
project_id Project ID
estimated_minutes Specifies estimated minutes for an event. Example values: 0-60
estimated_hours Specifies estimated hours for an event. Example values: 0-12
note Specifies notes for an event
from Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30"
to Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30"
label_ids Specifies label IDs for an event. Example values: label_ids:[2,3,4]
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters
billed Specifies whether you want an event to be marked as billed. For example: 'billed': false or 'billed': true

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 653,
  "uid": "eaae339c4d89fc102edd9dbdb6a28915",
  "user": {
    "id": 2170,
    "email": "marijaszwdpsyf@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/d647c8c26d1a0662b304fdbbe73dcb24?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/d647c8c26d1a0662b304fdbbe73dcb24?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/d647c8c26d1a0662b304fdbbe73dcb24?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/d647c8c26d1a0662b304fdbbe73dcb24?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/d647c8c26d1a0662b304fdbbe73dcb24?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:23+01:00"
  },
  "project": {
    "id": 593,
    "active": true,
    "account_id": 974,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018603,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 663,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:23+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 4,
    "minutes": 0,
    "seconds": 0,
    "formatted": "04:00",
    "total_hours": 4.0,
    "total_seconds": 14400,
    "total_minutes": 240
  },
  "cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "estimated_cost": {
    "fractional": 20000,
    "formatted": "$200.00",
    "amount": 200.0
  },
  "day": "2021-02-11",
  "note": "Updated notes",
  "sequence": 1,
  "estimated": true,
  "timer_state": "default",
  "timer_started_on": 0,
  "timer_stopped_on": 0,
  "label_ids": [

  ],
  "user_ids": [

  ],
  "updated_at": 1613018603,
  "created_at": 1613018603,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2021-02-11T09:13:23+01:00",
  "from": "2021-02-11T05:43:23+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 2170,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null,
  "draft": false,
  "manage": true,
  "locked_reason": null,
  "locked": false,
  "invoice_id": null,
  "timestamps": [

  ]
}

Forecasts (beta)

Forecasts (currently in beta as "Planning") lets you visualize upcoming work for all Timely users in one clean calendar view. You can then quickly assign work or edit plans across your different projects and teams.

Create a forecast

Request

curl "https://api.timelyapp.com/1.1/997/forecasts" -d '{"from":"2019-05-10","to":"2019-05-16","forecasts":{"note":"Note","from":"2019-05-10","to":"2019-05-16","hours":6,"minutes":0,"user_id":2215,"project_id":605}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer GYRZ1V2LsS_EANzv5aFCCcGsJ51jID5-zRz6pE_cWhk" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/forecasts

POST /1.1/997/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer GYRZ1V2LsS_EANzv5aFCCcGsJ51jID5-zRz6pE_cWhk

Parameters

{"from":"2019-05-10","to":"2019-05-16","forecasts":{"note":"Note","from":"2019-05-10","to":"2019-05-16","hours":6,"minutes":0,"user_id":2215,"project_id":605}}
Name Description
hours required Forecast hours
minutes required Forecast minutes
note Specifies notes for a forecast
from Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30"
to Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30"
user_id required The numerical ID of the desired user. Example values: 123
project_id required The numerical ID of the desired project. Example values: 123
label_ids Specifies label IDs for a forecast. Example values: label_ids:[2,3,4]

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 19,
  "note": "Note",
  "from": "2019-05-10",
  "to": "2019-05-16",
  "user": {
    "id": 2215,
    "email": "marijafkcfatcv@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/b602d86938d1a400d201aa91a523310a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/b602d86938d1a400d201aa91a523310a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/b602d86938d1a400d201aa91a523310a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/b602d86938d1a400d201aa91a523310a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/b602d86938d1a400d201aa91a523310a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:30+01:00"
  },
  "project": {
    "id": 605,
    "active": true,
    "name": "Timely",
    "color": "67a3bc",
    "client": {
      "id": 680,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:31+01:00"
    },
    "updated_at": "2021-02-11T05:43:31+01:00"
  },
  "hours": 6,
  "minutes": 0,
  "duration": {
    "hours": 6,
    "minutes": 0,
    "seconds": 0,
    "formatted": "06:00",
    "total_hours": 6.0,
    "total_seconds": 21600,
    "total_minutes": 360
  },
  "updated_at": "2021-02-11T05:43:31+01:00",
  "created_at": "2021-02-11T05:43:31+01:00",
  "label_ids": [

  ]
}

Delete a forecast

Request

curl "https://api.timelyapp.com/1.1/998/forecasts/20" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 3CISOgKRO-w09LqiVA3hVc-BaAAd4sGozKP4NzaGBNs" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/forecasts/:id

DELETE /1.1/998/forecasts/20
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3CISOgKRO-w09LqiVA3hVc-BaAAd4sGozKP4NzaGBNs

Parameters

Name Description
account_id The account ID containing the forecast you want to delete
id required The ID for the forecast you want to delete

Response

Content-Type: application/json; charset=utf-8
200 OK
{
}

List all forecasts

Request

curl -g "https://api.timelyapp.com/1.1/999/forecasts" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer UlZ3DnL24Ixr2WbuVmJI1kfEwzGCpOS7MhO97l0eR9M" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/forecasts

GET /1.1/999/forecasts
Accept: application/json
Content-Type: application/json
Authorization: Bearer UlZ3DnL24Ixr2WbuVmJI1kfEwzGCpOS7MhO97l0eR9M

Parameters

Name Description
account_id The account ID containing the forecasts you want to retrieve
user_id The user ID for the forecasts you want to retrieve
since Specifies the start date for returned results. Example: since=2014-08-18
upto Specifies the end date for returned results. Example: upto=2014-08-24
forecast_ids Specifies the forecasts for which you want results. Numerical forecast IDs should separated by a comma, like so: "user_ids": "175551,117861"
user_ids Specifies the users for which you want results. Numerical user IDs should separated by a comma, like so: "user_ids": "175551,117861"
project_ids Specifies the projects for which you want results. Numerical project IDs should be separated by a comma, like so: "project_ids": "1751,1171"
page Page number (Default 1)
per_page Records per page (Default 50)

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 21,
    "note": "note",
    "from": "2021-02-08",
    "to": "2021-02-14",
    "user": {
      "id": 2219,
      "email": "marijamxjvuift@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/080a5e3cca61fa573a50c1237900a17e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/080a5e3cca61fa573a50c1237900a17e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/080a5e3cca61fa573a50c1237900a17e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/080a5e3cca61fa573a50c1237900a17e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/080a5e3cca61fa573a50c1237900a17e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
      },
      "updated_at": "2021-02-11T05:43:32+01:00"
    },
    "project": {
      "id": 607,
      "active": true,
      "name": "Timely",
      "color": "67a3bc",
      "client": {
        "id": 682,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2021-02-11T05:43:32+01:00"
      },
      "updated_at": "2021-02-11T05:43:32+01:00"
    },
    "hours": 6,
    "minutes": 0,
    "duration": {
      "hours": 6,
      "minutes": 0,
      "seconds": 0,
      "formatted": "06:00",
      "total_hours": 6.0,
      "total_seconds": 21600,
      "total_minutes": 360
    },
    "updated_at": "2021-02-11T05:43:32+01:00",
    "created_at": "2021-02-11T05:43:32+01:00",
    "label_ids": [

    ]
  }
]

Update a forecast

Request

curl "https://api.timelyapp.com/1.1/1000/forecasts/22" -d '{"forecasts":{"note":"new note","from":"2019-05-10","to":"2019-05-16","hours":2,"minutes":0,"user_id":2221,"project_id":608}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer nRHPmvD-yhbDBjrmDjU0mUgC-dWTKzJoSkOs3S1vzWI" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/forecasts/:id

PUT /1.1/1000/forecasts/22
Accept: application/json
Content-Type: application/json
Authorization: Bearer nRHPmvD-yhbDBjrmDjU0mUgC-dWTKzJoSkOs3S1vzWI

Parameters

{"forecasts":{"note":"new note","from":"2019-05-10","to":"2019-05-16","hours":2,"minutes":0,"user_id":2221,"project_id":608}}
Name Description
id required Forecast ID
hours required Forecast hours
minutes required Forecast minutes
note Specifies notes for a forecast
from Specifies the “from” time in a timestamp. Example values: from: "2017-05-26T10:00:00+05:30"
to Specifies the “to” time in a timestamp. Example values: to: "2017-05-26T12:00:00+05:30"
user_id required The numerical ID of the desired user. Example values: 123
project_id required The numerical ID of the desired project. Example values: 123
label_ids Specifies label IDs for a forecast. Example values: label_ids:[2,3,4]

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 22,
  "note": "new note",
  "from": "2019-05-10",
  "to": "2019-05-16",
  "user": {
    "id": 2221,
    "email": "marijadcsflwmz@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/7228b962d0d82f654fd30dbce861f679?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/7228b962d0d82f654fd30dbce861f679?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/7228b962d0d82f654fd30dbce861f679?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/7228b962d0d82f654fd30dbce861f679?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
      "timeline": "https://www.gravatar.com/avatar/7228b962d0d82f654fd30dbce861f679?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
    },
    "updated_at": "2021-02-11T05:43:32+01:00"
  },
  "project": {
    "id": 608,
    "active": true,
    "name": "Timely",
    "color": "67a3bc",
    "client": {
      "id": 683,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:33+01:00"
    },
    "updated_at": "2021-02-11T05:43:33+01:00"
  },
  "hours": 2,
  "minutes": 0,
  "duration": {
    "hours": 2,
    "minutes": 0,
    "seconds": 0,
    "formatted": "02:00",
    "total_hours": 2.0,
    "total_seconds": 7200,
    "total_minutes": 120
  },
  "updated_at": "2021-02-11T05:43:33+01:00",
  "created_at": "2021-02-11T05:43:33+01:00",
  "label_ids": [

  ]
}

Labels

Labels (AKA Tags) help you classify work, group related tasks and require certain information for events. This API lets you to create, list, update and delete tags created on an account.

Create a label

Request

curl "https://api.timelyapp.com/1.1/1032/labels" -d '{"name":null,"label":{"name":"Web Programming","active":true}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer QJaWrCRIhXMnpIzyS50F7zNW6tHfRyeYT2_SLhdXE48" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/labels

POST /1.1/1032/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer QJaWrCRIhXMnpIzyS50F7zNW6tHfRyeYT2_SLhdXE48

Parameters

{"name":null,"label":{"name":"Web Programming","active":true}}
Name Description
name required Specifies the label name
emoji Specifies the emoji url for a label
parent_id Set a parent_id if you want to create a child label
active Example values: "true" or "false". Using "false" changes the label state to "archived"

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 33,
  "name": "Web Programming",
  "sequence": 1,
  "parent_id": null,
  "emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v4.0.4/img-twitter-64/1f3f7-fe0f.png",
  "active": true,
  "children": [

  ]
}

Delete a label

Request

curl "https://api.timelyapp.com/1.1/1033/labels/34" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer uolwUIlEGFvoaxBIOzAlT2tx7Bgb9tyDCkw8NE5pYXk" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/labels/:id

DELETE /1.1/1033/labels/34
Accept: application/json
Content-Type: application/json
Authorization: Bearer uolwUIlEGFvoaxBIOzAlT2tx7Bgb9tyDCkw8NE5pYXk

Parameters

Name Description
account_id The account ID containing the label you want to delete
id The ID of the label you want to delete

Response

Content-Type: application/json; charset=utf-8
200 OK
{
}

List all child labels

Get the children of any tag on a user’s account.

Request

curl -g "https://api.timelyapp.com/1.1/1036/labels?parent_id=36" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ur3RXiKEvJ19P5UTFgeJSwUa3Q4nIzU-ZWxUZGHJEyw" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/labels

GET /1.1/1036/labels?parent_id=36
Accept: application/json
Content-Type: application/json
Authorization: Bearer ur3RXiKEvJ19P5UTFgeJSwUa3Q4nIzU-ZWxUZGHJEyw

Parameters

parent_id: 36
Name Description
account_id The account ID containing the label you want to. retrieve
parent_id The parent ID whose children you want to retrieve

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 36,
  "name": "Web Programming",
  "sequence": 1,
  "parent_id": null,
  "emoji": null,
  "active": true,
  "children": [

  ]
}

List all labels

Get all the tags present in user’s account.

Request

curl -g "https://api.timelyapp.com/1.1/1035/labels" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer p9bmWpDSH44G6RCEMxhoeRGVjSdnZECv46Hp-9xbIfw" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/labels

GET /1.1/1035/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer p9bmWpDSH44G6RCEMxhoeRGVjSdnZECv46Hp-9xbIfw

Parameters

Name Description
account_id The account ID containing the label you want to. retrieve
offset Retrieve labels from offset
limit Retrieve number of labels
filter Specifies which records to retrieve. The default shows a current workspace’s all labels (filter=all). Example: "filter=all" or "filter=active" or "filter=archived"

Response

Content-Type: application/json; charset=utf-8
200 OK
[

]

Retrieve a label

Get single tags present in user’s account.

Request

curl -g "https://api.timelyapp.com/1.1/1034/labels/35" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer b08VfWspsfx9OclD8JLMjWBLj0nhHxEOm5Z5e6wtWNU" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/labels/:id

GET /1.1/1034/labels/35
Accept: application/json
Content-Type: application/json
Authorization: Bearer b08VfWspsfx9OclD8JLMjWBLj0nhHxEOm5Z5e6wtWNU

Parameters

Name Description
account_id The account ID containing the label you want to. retrieve
id The ID of the label you want to retrieve

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 35,
  "name": "Web Programming",
  "sequence": 1,
  "parent_id": null,
  "emoji": null,
  "active": true,
  "children": [

  ]
}

Update a label

Request

curl "https://api.timelyapp.com/1.1/1037/labels/37" -d '{"name":null,"label":{"name":"updated name"}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer -_BvER1HicP2tCSKcSPlYCefC6SljRQcbtBT12po6Hk" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/labels/:id

PUT /1.1/1037/labels/37
Accept: application/json
Content-Type: application/json
Authorization: Bearer -_BvER1HicP2tCSKcSPlYCefC6SljRQcbtBT12po6Hk

Parameters

{"name":null,"label":{"name":"updated name"}}
Name Description
id required Label ID
name required Specifies the label name
emoji Specifies the emoji url for a tag
parent_id Set a parent_id if you want to create a child label
active Example values: "true" or "false". Using "false" changes the label state to "archived"

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 37,
  "name": "updated name",
  "sequence": 1,
  "parent_id": null,
  "emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v4.0.4/img-twitter-64/1f3f7-fe0f.png",
  "active": true,
  "children": [

  ]
}

Permissions

Retrieve current user's permissions

Using the account id one can see the currently logged user's permissions

Request

curl -g "https://api.timelyapp.com/1.1/1048/users/current/permissions" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer l4MAkFdOESlgnQ6_GjvkkGtT6zoMCHfM5HIpJeS9slw" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/current/permissions

GET /1.1/1048/users/current/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer l4MAkFdOESlgnQ6_GjvkkGtT6zoMCHfM5HIpJeS9slw

Parameters

Name Description
account_id Account id for which current user's permissions are to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "resource": "user",
    "permissions": [
      "create",
      "read",
      "update",
      "delete",
      "notify"
    ]
  },
  {
    "resource": "project",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "label",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "company",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "team",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "account",
    "permissions": [
      "create",
      "read",
      "update",
      "manage_plan",
      "manage_subscriptions",
      "manage_dev"
    ]
  },
  {
    "resource": "report",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "forecast",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "invoice",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  }
]

Retrieve user's permissions by id

Using the account id and user id one can see a specific user's permissions

Request

curl -g "https://api.timelyapp.com/1.1/1049/users/2316/permissions" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer OanExGcP9CY8k8wf9SLaYsax7YRWeB80q6BQnfsEVVg" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/:user_id/permissions

GET /1.1/1049/users/2316/permissions
Accept: application/json
Content-Type: application/json
Authorization: Bearer OanExGcP9CY8k8wf9SLaYsax7YRWeB80q6BQnfsEVVg

Parameters

Name Description
account_id Account for which user's permissions are required
user_id User whose permissions are required

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "resource": "user",
    "permissions": [
      "create",
      "read",
      "update",
      "delete",
      "notify"
    ]
  },
  {
    "resource": "project",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "label",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "company",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "team",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "account",
    "permissions": [
      "create",
      "read",
      "update",
      "manage_plan",
      "manage_subscriptions",
      "manage_dev"
    ]
  },
  {
    "resource": "report",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "forecast",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  },
  {
    "resource": "invoice",
    "permissions": [
      "create",
      "read",
      "update",
      "delete"
    ]
  }
]

Projects

Projects contain all the project details on an account. With this API, you can retrieve, update, create or delete a specific project, or list all projects.

Create a project

Request

curl "https://api.timelyapp.com/1.1/1055/projects" -d '{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","enable_labels":"all","client_id":721,"budget_type":"M","budget":300,"users":[{"user_id":2328}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":38,"required":true},{"label_id":39,"required":true},{"label_id":40,"required":false},{"label_id":41,"required":false}]},"name":null}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ZwNI8gWrBjPpIRj4N4HgL_ro2w-wylbCXRXbzxv-fEA" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/projects

POST /1.1/1055/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer ZwNI8gWrBjPpIRj4N4HgL_ro2w-wylbCXRXbzxv-fEA

Parameters

{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","enable_labels":"all","client_id":721,"budget_type":"M","budget":300,"users":[{"user_id":2328}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":38,"required":true},{"label_id":39,"required":true},{"label_id":40,"required":false},{"label_id":41,"required":false}]},"name":null}
Name Description
project required Project attributes
name required Specifies the project name
color required Specifies the project color. Example values: 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0
client_id required Specifies the numerical client ID
users required Specifies the project users. It should be an array of users, with numerical user IDs and an hour_rate. For example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }]
billable Specifies whether the project is billable or not. It should be “true” or “false”
budget Specifies the budget for the project. It should be numeric value
hour_rate Specifies the hourly rate for the project. It should be numeric valu
rate_type Specifies the hourly rate type for the project. It should be “user” or “project”
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)
budget_recurrence Specifies when a recurring budget will refresh
send_invite Specifies if you want to send a project invite email. It should be “true” or “false”
required_notes Project hours notes to be required for logging
labels Specifies the project labels, should be array of labels with numerical label id and required flag Example: "labels": [{ "label_id": 1, "required": true }, { "label_id": 2, "required": false }]
enable_labels Specifies the way labels will be allowed for logging for the project. It should be “all”, “none” or “custom”

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 639,
  "active": true,
  "account_id": 1055,
  "name": "New Project",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1613018633,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 721,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2021-02-11T05:43:53+01:00"
  },
  "required_notes": false,
  "budget_expired_on": null,
  "has_recurrence": true,
  "enable_labels": "all",
  "budget": 300,
  "budget_type": "M",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "budget_progress": 0.0,
  "budget_percent": 0.0,
  "users": [
    {
      "user_id": 2328,
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "updated_at": "2021-02-11T05:43:53+01:00",
      "created_at": "2021-02-11T05:43:53+01:00",
      "deleted": false
    }
  ],
  "labels": [
    {
      "project_id": 639,
      "label_id": 38,
      "budget": 0,
      "required": true,
      "updated_at": "2021-02-11T10:13:53+05:30"
    },
    {
      "project_id": 639,
      "label_id": 39,
      "budget": 0,
      "required": true,
      "updated_at": "2021-02-11T10:13:53+05:30"
    },
    {
      "project_id": 639,
      "label_id": 40,
      "budget": 0,
      "required": false,
      "updated_at": "2021-02-11T10:13:53+05:30"
    },
    {
      "project_id": 639,
      "label_id": 41,
      "budget": 0,
      "required": false,
      "updated_at": "2021-02-11T10:13:53+05:30"
    }
  ],
  "label_ids": [
    38,
    39,
    40,
    41
  ],
  "required_label_ids": [
    38,
    39
  ],
  "cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "estimated_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "billed_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "billed_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "unbilled_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "unbilled_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "first_logged_on": null,
  "last_logged_on": null,
  "budget_recurrence": {
    "recur": "week",
    "start_date": "2018-09-21",
    "end_date": "2019-09-21",
    "recur_until": "end_date",
    "days_count": 365,
    "updated_at": "2021-02-11T05:43:53+01:00"
  }
}

Delete a project

Request

curl "https://api.timelyapp.com/1.1/1056/projects/640" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer -cl4fmlyYCo5tAxS6qjka69IYuP5_L9m3jrTaNjRqqo" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/projects/:id

DELETE /1.1/1056/projects/640
Accept: application/json
Content-Type: application/json
Authorization: Bearer -cl4fmlyYCo5tAxS6qjka69IYuP5_L9m3jrTaNjRqqo

Parameters

Name Description
account_id The account ID containing the project you want to delete
id The ID of the project you want to delete

Response

Content-Type: application/json; charset=utf-8
200 OK
{
}

List all projects

Note: Admin users can access all projects on an account. Other users can only access the projects they belong to.

Project lists will return your 10000 most recently updated projects. Additionally, you can add the “limit”, “filter”, ”sort” and “order” optional parameters to change the result.

Request

curl -g "https://api.timelyapp.com/1.1/1058/projects" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer sQOTi9FmHsPNX9us3xKOks9GVQwTW56MCd1EKPzjC1I" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/projects

GET /1.1/1058/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer sQOTi9FmHsPNX9us3xKOks9GVQwTW56MCd1EKPzjC1I

Parameters

Name Description
offset Retrieve projects from offset
limit Retrieve number of projects
sort Field to sort projects by (Default updated_at)
order Sorting order (Default desc)
filter Filter projects - mine, active, archived, all
updated_after Retrieve records updated after a certain timestamp
project_ids Retrieve specific projects

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 642,
    "active": true,
    "account_id": 1058,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1613018635,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 724,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2021-02-11T05:43:55+01:00"
    },
    "required_notes": false,
    "budget_expired_on": null,
    "has_recurrence": false,
    "enable_labels": "all",
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "budget_progress": 0.0,
    "budget_percent": 0.0,
    "users": [
      {
        "user_id": 2334,
        "hour_rate": 100.0,
        "hour_rate_in_cents": 10000.0,
        "updated_at": "2021-02-11T05:43:55+01:00",
        "created_at": "2021-02-11T05:43:55+01:00",
        "deleted": false
      }
    ],
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ],
    "cost": {
      "fractional": 0,
      "formatted": "$0.00",
      "amount": 0.0
    },
    "estimated_cost": {
      "fractional": 0,
      "formatted": "$0.00",
      "amount": 0.0
    },
    "duration": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "formatted": "00:00",
      "total_hours": 0.0,
      "total_seconds": 0,
      "total_minutes": 0
    },
    "estimated_duration": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "formatted": "00:00",
      "total_hours": 0.0,
      "total_seconds": 0,
      "total_minutes": 0
    },
    "billed_cost": {
      "fractional": 0,
      "formatted": "$0.00",
      "amount": 0.0
    },
    "billed_duration": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "formatted": "00:00",
      "total_hours": 0.0,
      "total_seconds": 0,
      "total_minutes": 0
    },
    "unbilled_cost": {
      "fractional": 0,
      "formatted": "$0.00",
      "amount": 0.0
    },
    "unbilled_duration": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "formatted": "00:00",
      "total_hours": 0.0,
      "total_seconds": 0,
      "total_minutes": 0
    }
  }
]

Retrieve a project

Retrieve a single project by using its ID.

Request

curl -g "https://api.timelyapp.com/1.1/1057/projects/641" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 6Zy6R_liCGYQ-ZruhTWWUnrztXdcueP_3eKwMM9iQn8" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/projects/:id

GET /1.1/1057/projects/641
Accept: application/json
Content-Type: application/json
Authorization: Bearer 6Zy6R_liCGYQ-ZruhTWWUnrztXdcueP_3eKwMM9iQn8

Parameters

Name Description
account_id The account ID containing the project you want to retrieve
id The ID of the project you want to retrieve

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 641,
  "active": true,
  "account_id": 1057,
  "name": "Timely",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1613018634,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 723,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2021-02-11T05:43:54+01:00"
  },
  "required_notes": false,
  "budget_expired_on": null,
  "has_recurrence": false,
  "enable_labels": "all",
  "budget": 0,
  "budget_type": "",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "budget_progress": 0.0,
  "budget_percent": 0.0,
  "users": [
    {
      "user_id": 2332,
      "hour_rate": 100.0,
      "hour_rate_in_cents": 10000.0,
      "updated_at": "2021-02-11T05:43:54+01:00",
      "created_at": "2021-02-11T05:43:54+01: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/1060/projects/644" -d '{"project":{"name":"updated project name"},"name":null}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer RVlZToa4DLz-mbwynn81m0l1T9Hf3jLRLOqJyrvrrgg" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/projects/:id

PUT /1.1/1060/projects/644
Accept: application/json
Content-Type: application/json
Authorization: Bearer RVlZToa4DLz-mbwynn81m0l1T9Hf3jLRLOqJyrvrrgg

Parameters

{"project":{"name":"updated project name"},"name":null}
Name Description
id required Project ID
project Project attributes
name required Specifies the project name
active Example values: “true” or “false”. Using “false” changes the project state to “archived”
color required Specifies the project color. It should be one of these: 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0
client_id required Specifies the numerical client ID
users required Specifies the project users. It should be an array of users, with numerical user IDs and an hour_rate. For example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }]
billable Specifies whether the project is billable or not. It should be “true” or “false”
budget Specifies the budget for the project. It should be numeric value
hour_rate Specifies the hourly rate for the project. It should be numeric value
rate_type Specifies the hourly rate type for the project. It should be “user” or “project”
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)
send_invite Specifies if you want to send a project invite email. It should be “true” or “false”
required_notes Project hours notes to be required for logging
enable_labels Specifies the way labels will be allowed for logging the project. It should be “all”, “none” or “custom”

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 644,
  "active": true,
  "account_id": 1060,
  "name": "updated project name",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1613018636,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 726,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2021-02-11T05:43:56+01:00"
  },
  "required_notes": false,
  "budget_expired_on": null,
  "has_recurrence": false,
  "enable_labels": "none",
  "budget": 0,
  "budget_type": "",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "budget_progress": 0.0,
  "budget_percent": 0.0,
  "users": [
    {
      "user_id": 2338,
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "updated_at": "2021-02-11T05:43:56+01:00",
      "created_at": "2021-02-11T05:43:56+01:00",
      "deleted": false
    }
  ],
  "labels": [

  ],
  "label_ids": [

  ],
  "required_label_ids": [

  ],
  "cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "estimated_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "billed_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "billed_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "unbilled_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "unbilled_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "first_logged_on": null,
  "last_logged_on": null
}

Reports

Report on activity across your business, including individual and team performance. Export report data from JSON to a format of your choice. Note: .XLS, .CSV and .PDF report formats can only be downloaded from the web UI, not the API.

All Reports

For a normal user accessing all account reports.

Note:

1) If start_date and end_date parameters are not passed, the period will default to the beginning-to-end of a month. 2) If user and project parameters are not passed, by default a normal user will get all reports on an account, and a limited user will only get reports they have created. 3) Only normal users can access reports created by other users on an account. Limited users can only access reports they have created. 4) Only normal users can access reports for other projects on an account. Limited users can only access reports for projects they have created.

Request

curl "https://api.timelyapp.com/1.1/1092/reports" -d '{"user_ids":"2433","since":"2018-01-01","until":"2019-01-01","project_ids":"713"}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer eeQ0IxGIsw1o7N00Upa2xAuDslbGdTJ2MU0lu3rHhkE" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/reports

POST /1.1/1092/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer eeQ0IxGIsw1o7N00Upa2xAuDslbGdTJ2MU0lu3rHhkE

Parameters

{"user_ids":"2433","since":"2018-01-01","until":"2019-01-01","project_ids":"713"}
Name Description
account_id The account ID containing the report you want to retrieve
user_ids Specifies the users for which you want reports. Numerical user IDs should separated by a comma, like so: "user_ids": "175551,117861"
since Specifies the start date for a report: For example: "since" : "Jan 01, 2014"
until Specifies the end date for a report. For example: "until" : "Dec 31, 2014"
project_ids Specifies the projects for which you want reports. Numerical project IDs should be separated by a comma, like so: "project_ids": "1751,1171"
billed Specifies whether you want to report to show estimated or billed events. For example: "billed": false or "billed": true
label_ids Specifies the labels pertaining to a report you want to see. Numerical label IDs should be separated by a comma, like so: "label_ids": "751,117"

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 758,
    "name": "Timely",
    "projects": [
      {
        "id": 713,
        "active": true,
        "account_id": 1092,
        "name": "Timely",
        "color": "67a3bc",
        "rate_type": "project",
        "billable": true,
        "updated_at": 1613018655,
        "external_id": null,
        "budget_scope": null,
        "client": {
          "id": 758,
          "name": "Timely",
          "active": true,
          "external_id": null,
          "updated_at": "2021-02-11T05:44:15+01:00"
        },
        "required_notes": false,
        "budget_expired_on": null,
        "has_recurrence": false,
        "enable_labels": "all",
        "budget": 0,
        "budget_type": "",
        "hour_rate": 50.0,
        "hour_rate_in_cents": 5000.0,
        "budget_progress": 0.0,
        "budget_percent": 0.0,
        "duration": {
          "hours": 5,
          "minutes": 0,
          "seconds": 0,
          "formatted": "05:00",
          "total_hours": 5.0,
          "total_seconds": 18000,
          "total_minutes": 300
        },
        "estimated_duration": {
          "hours": 8,
          "minutes": 0,
          "seconds": 0,
          "formatted": "08:00",
          "total_hours": 8.0,
          "total_seconds": 28800,
          "total_minutes": 480
        },
        "billed_duration": {
          "hours": 0,
          "minutes": 0,
          "seconds": 0,
          "formatted": "00:00",
          "total_hours": 0.0,
          "total_seconds": 0,
          "total_minutes": 0
        },
        "unbilled_duration": {
          "hours": 5,
          "minutes": 0,
          "seconds": 0,
          "formatted": "05:00",
          "total_hours": 5.0,
          "total_seconds": 18000,
          "total_minutes": 300
        },
        "cost": {
          "fractional": 25000,
          "formatted": "$250.00",
          "amount": 250.0
        },
        "estimated_cost": {
          "fractional": 40000,
          "formatted": "$400.00",
          "amount": 400.0
        },
        "billed_cost": {
          "fractional": 0,
          "formatted": "$0.00",
          "amount": 0.0
        },
        "unbilled_cost": {
          "fractional": 25000,
          "formatted": "$250.00",
          "amount": 250.0
        }
      }
    ],
    "duration": {
      "hours": 5,
      "minutes": 0,
      "seconds": 0,
      "formatted": "05:00",
      "total_hours": 5.0,
      "total_seconds": 18000,
      "total_minutes": 300
    },
    "estimated_duration": {
      "hours": 8,
      "minutes": 0,
      "seconds": 0,
      "formatted": "08:00",
      "total_hours": 8.0,
      "total_seconds": 28800,
      "total_minutes": 480
    },
    "billed_duration": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "formatted": "00:00",
      "total_hours": 0.0,
      "total_seconds": 0,
      "total_minutes": 0
    },
    "unbilled_duration": {
      "hours": 5,
      "minutes": 0,
      "seconds": 0,
      "formatted": "05:00",
      "total_hours": 5.0,
      "total_seconds": 18000,
      "total_minutes": 300
    },
    "cost": {
      "fractional": 25000,
      "formatted": "$250.00",
      "amount": 250.0
    },
    "estimated_cost": {
      "fractional": 40000,
      "formatted": "$400.00",
      "amount": 400.0
    },
    "billed_cost": {
      "fractional": 0,
      "formatted": "$0.00",
      "amount": 0.0
    },
    "unbilled_cost": {
      "fractional": 25000,
      "formatted": "$250.00",
      "amount": 250.0
    }
  }
]

Filter reports

Use filter endpoints with parameters to limit returned data, so you only see the values that you need.

Request

curl "https://api.timelyapp.com1.1/1093/reports/filter" -d '{"user_ids":"2435","since":"2018-01-01","until":"2019-01-01","project_ids":"714"}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer oFAd-tQZC__3nZZ39NtnLHRJbeCU_nEo4Y0CB-xl-wg" \
    -H "Cookie: "

Endpoint

POST 1.1/:account_id/reports/filter

POST 1.1/1093/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer oFAd-tQZC__3nZZ39NtnLHRJbeCU_nEo4Y0CB-xl-wg

Parameters

{"user_ids":"2435","since":"2018-01-01","until":"2019-01-01","project_ids":"714"}
Name Description
billed Retrieve billed hours only. Example: billed=true
label_ids Specifies the label IDs of the hours you want to retrieve. Label IDs should be a numerical array, like so: label_ids: [3, 4, 2]
project_ids Specifies the project IDs of the hours you want to retrieve. Project IDs should be a numerical array, like so: project_ids: [3, 4, 2]
since The start date of a report. For example: 'since=2019-01-01'
team_ids Specifies the team IDs of the hours you want to retrieve. Team IDs should be a numerical array, like so: team_ids: [3, 4, 2]
until The end date of a report. For example: 'until=2019-12-31''
user_ids Specifies the user IDs of the hours you want to retrieve. User IDs should be a numerical array, like so: user_ids: [3, 4, 2]
group_by Specifies how to group the hours. Default: group_by: ["clients", "users", "labels", "days", "teams"]

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "totals": {
    "duration": {
      "hours": 5,
      "minutes": 0,
      "seconds": 0,
      "formatted": "05:00",
      "total_hours": 5.0,
      "total_seconds": 18000,
      "total_minutes": 300
    },
    "estimated_duration": {
      "hours": 8,
      "minutes": 0,
      "seconds": 0,
      "formatted": "08:00",
      "total_hours": 8.0,
      "total_seconds": 28800,
      "total_minutes": 480
    },
    "billed_duration": {
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "formatted": "00:00",
      "total_hours": 0.0,
      "total_seconds": 0,
      "total_minutes": 0
    },
    "unbilled_duration": {
      "hours": 5,
      "minutes": 0,
      "seconds": 0,
      "formatted": "05:00",
      "total_hours": 5.0,
      "total_seconds": 18000,
      "total_minutes": 300
    },
    "cost": {
      "fractional": 25000,
      "formatted": "$250.00",
      "amount": 250.0
    },
    "estimated_cost": {
      "fractional": 40000,
      "formatted": "$400.00",
      "amount": 400.0
    },
    "billed_cost": {
      "fractional": 0,
      "formatted": "$0.00",
      "amount": 0.0
    },
    "unbilled_cost": {
      "fractional": 25000,
      "formatted": "$250.00",
      "amount": 250.0
    }
  },
  "clients": [
    {
      "id": 759,
      "name": "Timely",
      "projects": [
        {
          "id": 714,
          "active": true,
          "account_id": 1093,
          "name": "Timely",
          "color": "67a3bc",
          "rate_type": "project",
          "billable": true,
          "updated_at": 1613018655,
          "external_id": null,
          "budget_scope": null,
          "client": {
            "id": 759,
            "name": "Timely",
            "active": true,
            "external_id": null,
            "updated_at": "2021-02-11T05:44:15+01:00"
          },
          "required_notes": false,
          "budget_expired_on": null,
          "has_recurrence": false,
          "enable_labels": "all",
          "budget": 0,
          "budget_type": "",
          "hour_rate": 50.0,
          "hour_rate_in_cents": 5000.0,
          "budget_progress": 0.0,
          "budget_percent": 0.0,
          "duration": {
            "hours": 5,
            "minutes": 0,
            "seconds": 0,
            "formatted": "05:00",
            "total_hours": 5.0,
            "total_seconds": 18000,
            "total_minutes": 300
          },
          "estimated_duration": {
            "hours": 8,
            "minutes": 0,
            "seconds": 0,
            "formatted": "08:00",
            "total_hours": 8.0,
            "total_seconds": 28800,
            "total_minutes": 480
          },
          "billed_duration": {
            "hours": 0,
            "minutes": 0,
            "seconds": 0,
            "formatted": "00:00",
            "total_hours": 0.0,
            "total_seconds": 0,
            "total_minutes": 0
          },
          "unbilled_duration": {
            "hours": 5,
            "minutes": 0,
            "seconds": 0,
            "formatted": "05:00",
            "total_hours": 5.0,
            "total_seconds": 18000,
            "total_minutes": 300
          },
          "cost": {
            "fractional": 25000,
            "formatted": "$250.00",
            "amount": 250.0
          },
          "estimated_cost": {
            "fractional": 40000,
            "formatted": "$400.00",
            "amount": 400.0
          },
          "billed_cost": {
            "fractional": 0,
            "formatted": "$0.00",
            "amount": 0.0
          },
          "unbilled_cost": {
            "fractional": 25000,
            "formatted": "$250.00",
            "amount": 250.0
          }
        }
      ],
      "duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "estimated_duration": {
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "formatted": "08:00",
        "total_hours": 8.0,
        "total_seconds": 28800,
        "total_minutes": 480
      },
      "billed_duration": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "formatted": "00:00",
        "total_hours": 0.0,
        "total_seconds": 0,
        "total_minutes": 0
      },
      "unbilled_duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      },
      "estimated_cost": {
        "fractional": 40000,
        "formatted": "$400.00",
        "amount": 400.0
      },
      "billed_cost": {
        "fractional": 0,
        "formatted": "$0.00",
        "amount": 0.0
      },
      "unbilled_cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      }
    }
  ],
  "users": [
    {
      "id": 2435,
      "email": "marijaddoslzsa@timelyapp.com",
      "name": "Marija Petrovic",
      "time_zone": "Europe/Paris",
      "updated_at": 1613018655,
      "active": false,
      "deleted": false,
      "memory_onboarded": true,
      "day_view_onboarded": true,
      "last_received_memories_date": null,
      "date_format": "dmy",
      "time_format": "24",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/4fe684d6a1eff391a6ec8d01972cd16d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/4fe684d6a1eff391a6ec8d01972cd16d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/4fe684d6a1eff391a6ec8d01972cd16d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/4fe684d6a1eff391a6ec8d01972cd16d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/4fe684d6a1eff391a6ec8d01972cd16d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-e61ac46443487bd24fbaecab08cfacf5d0835b371cbe97a33b9e738744ef8334.jpg&s="
      },
      "duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "estimated_duration": {
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "formatted": "08:00",
        "total_hours": 8.0,
        "total_seconds": 28800,
        "total_minutes": 480
      },
      "billed_duration": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "formatted": "00:00",
        "total_hours": 0.0,
        "total_seconds": 0,
        "total_minutes": 0
      },
      "unbilled_duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      },
      "estimated_cost": {
        "fractional": 40000,
        "formatted": "$400.00",
        "amount": 400.0
      },
      "billed_cost": {
        "fractional": 0,
        "formatted": "$0.00",
        "amount": 0.0
      },
      "unbilled_cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      }
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "Untagged",
      "sequence": -1,
      "parent_id": null,
      "emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v2.4.4/img-twitter-64/1f3f7.png",
      "active": true,
      "children": [

      ],
      "duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "estimated_duration": {
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "formatted": "08:00",
        "total_hours": 8.0,
        "total_seconds": 28800,
        "total_minutes": 480
      },
      "billed_duration": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "formatted": "00:00",
        "total_hours": 0.0,
        "total_seconds": 0,
        "total_minutes": 0
      },
      "unbilled_duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      },
      "estimated_cost": {
        "fractional": 40000,
        "formatted": "$400.00",
        "amount": 400.0
      },
      "billed_cost": {
        "fractional": 0,
        "formatted": "$0.00",
        "amount": 0.0
      },
      "unbilled_cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      }
    }
  ],
  "days": [
    {
      "day": "2018-01-02",
      "duration": {
        "hours": 2,
        "minutes": 30,
        "seconds": 0,
        "formatted": "02:30",
        "total_hours": 2.5,
        "total_seconds": 9000,
        "total_minutes": 150
      },
      "estimated_duration": {
        "hours": 4,
        "minutes": 0,
        "seconds": 0,
        "formatted": "04:00",
        "total_hours": 4.0,
        "total_seconds": 14400,
        "total_minutes": 240
      },
      "billed_duration": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "formatted": "00:00",
        "total_hours": 0.0,
        "total_seconds": 0,
        "total_minutes": 0
      },
      "unbilled_duration": {
        "hours": 2,
        "minutes": 30,
        "seconds": 0,
        "formatted": "02:30",
        "total_hours": 2.5,
        "total_seconds": 9000,
        "total_minutes": 150
      },
      "cost": {
        "fractional": 12500,
        "formatted": "$125.00",
        "amount": 125.0
      },
      "estimated_cost": {
        "fractional": 20000,
        "formatted": "$200.00",
        "amount": 200.0
      },
      "billed_cost": {
        "fractional": 0,
        "formatted": "$0.00",
        "amount": 0.0
      },
      "unbilled_cost": {
        "fractional": 12500,
        "formatted": "$125.00",
        "amount": 125.0
      }
    },
    {
      "day": "2018-01-01",
      "duration": {
        "hours": 2,
        "minutes": 30,
        "seconds": 0,
        "formatted": "02:30",
        "total_hours": 2.5,
        "total_seconds": 9000,
        "total_minutes": 150
      },
      "estimated_duration": {
        "hours": 4,
        "minutes": 0,
        "seconds": 0,
        "formatted": "04:00",
        "total_hours": 4.0,
        "total_seconds": 14400,
        "total_minutes": 240
      },
      "billed_duration": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "formatted": "00:00",
        "total_hours": 0.0,
        "total_seconds": 0,
        "total_minutes": 0
      },
      "unbilled_duration": {
        "hours": 2,
        "minutes": 30,
        "seconds": 0,
        "formatted": "02:30",
        "total_hours": 2.5,
        "total_seconds": 9000,
        "total_minutes": 150
      },
      "cost": {
        "fractional": 12500,
        "formatted": "$125.00",
        "amount": 125.0
      },
      "estimated_cost": {
        "fractional": 20000,
        "formatted": "$200.00",
        "amount": 200.0
      },
      "billed_cost": {
        "fractional": 0,
        "formatted": "$0.00",
        "amount": 0.0
      },
      "unbilled_cost": {
        "fractional": 12500,
        "formatted": "$125.00",
        "amount": 125.0
      }
    }
  ],
  "teams": [
    {
      "id": 0,
      "name": "No team",
      "color": "866b9c",
      "emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v4.0.4/img-twitter-64/1f465.png",
      "external_id": null,
      "duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "estimated_duration": {
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "formatted": "08:00",
        "total_hours": 8.0,
        "total_seconds": 28800,
        "total_minutes": 480
      },
      "billed_duration": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "formatted": "00:00",
        "total_hours": 0.0,
        "total_seconds": 0,
        "total_minutes": 0
      },
      "unbilled_duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      },
      "estimated_cost": {
        "fractional": 40000,
        "formatted": "$400.00",
        "amount": 400.0
      },
      "billed_cost": {
        "fractional": 0,
        "formatted": "$0.00",
        "amount": 0.0
      },
      "unbilled_cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      }
    }
  ]
}

Roles

List roles

Note: default attribute shows which role to select by default

Request

curl -g "https://api.timelyapp.com/1.1/1094/roles" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer -hxdbgsgmvWPmQRF_svSss1CSe9vjIltAOY7omZxUnU" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/roles

GET /1.1/1094/roles
Accept: application/json
Content-Type: application/json
Authorization: Bearer -hxdbgsgmvWPmQRF_svSss1CSe9vjIltAOY7omZxUnU

Parameters

Name Description
account_id Account id for which roles are required

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 3280,
    "name": "admin",
    "display_name": "Admin",
    "description": "Can see, create and edit all hours, projects and teams.",
    "scopes": [
      {
        "name": "hide_hourly_rate",
        "display_name": "Hide rate",
        "description": "Hide hourly rates for this user",
        "default": false,
        "options": [
          false
        ]
      }
    ],
    "default": false
  },
  {
    "id": 3282,
    "name": "employee",
    "display_name": "Employee",
    "description": "Can only see, log and edit their own hours.",
    "scopes": [
      {
        "name": "hide_hourly_rate",
        "display_name": "Hide rate",
        "description": "Hide hourly rates for this user",
        "default": false,
        "options": [
          true,
          false
        ]
      }
    ],
    "default": false
  },
  {
    "id": 3281,
    "name": "manager",
    "display_name": "Manager",
    "description": "Can see, log and edit hours for anyone on the same project as them.",
    "scopes": [
      {
        "name": "hide_hourly_rate",
        "display_name": "Hide rate",
        "description": "Hide hourly rates for this user",
        "default": false,
        "options": [
          true,
          false
        ]
      }
    ],
    "default": true
  }
]

Teams

The team object shows all teams available on an account.

Create a team

Request

curl "https://api.timelyapp.com/1.1/1116/teams" -d '{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2481,"lead":true},{"user_id":2483,"lead":false}]}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer uZ-xuH8GgRP1lNtKNVSjbkH2ZaMAjN4NkgXA9Ik0ygA" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/teams

POST /1.1/1116/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer uZ-xuH8GgRP1lNtKNVSjbkH2ZaMAjN4NkgXA9Ik0ygA

Parameters

{"name":null,"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2481,"lead":true},{"user_id":2483,"lead":false}]}}
Name Description
name required Specifies the team name
emoji Specifies the emoji url for a team
color Specifies the project color for a team
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)
users required Specifies users and their role within a team. For example: users:[{'user_id': 1, 'lead': true}]

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 9,
  "name": "Timely",
  "color": "67a3bc",
  "emoji": "http://path.to/emoji.png",
  "external_id": null,
  "user_ids": [
    2481,
    2483
  ],
  "users": [
    {
      "id": 11,
      "user_id": 2481,
      "team_id": 9,
      "lead": true
    },
    {
      "id": 12,
      "user_id": 2483,
      "team_id": 9,
      "lead": false
    }
  ]
}

Delete a team

Request

curl "https://api.timelyapp.com/1.1/1117/teams/10" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer m66jzy8IcGznkM8RSTWSQHEKXkc4Hkjd-QYTI8kDWmM" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/teams/:id

DELETE /1.1/1117/teams/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer m66jzy8IcGznkM8RSTWSQHEKXkc4Hkjd-QYTI8kDWmM

Parameters

Name Description
account_id The account ID containing the team you want to delete
id The ID of the team you want to delete

Response

Content-Type: application/json; charset=utf-8
200 OK
{
}

List all teams

Request

curl -g "https://api.timelyapp.com/1.1/1119/teams" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 3St3dpa5hkVR9Bm4q7U4F6J_EG42hk-8LBR2U39fdo0" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/teams

GET /1.1/1119/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer 3St3dpa5hkVR9Bm4q7U4F6J_EG42hk-8LBR2U39fdo0

Parameters

Name Description
page Page number (Default 1)
per_page Records per page (Default 50)
order Sorting order on name
filter Filter teams - mine, all

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 12,
    "name": "Timely",
    "color": "67a3bc",
    "emoji": "http://path.to/emoji.png",
    "external_id": null,
    "user_ids": [

    ],
    "users": [

    ]
  }
]

Retrieve a team

Request

curl -g "https://api.timelyapp.com/1.1/1118/teams/11" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ulUw_8H17EAefCbQ1LEvDAutz6GV5PtDpTgJBScNzM4" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/teams/:id

GET /1.1/1118/teams/11
Accept: application/json
Content-Type: application/json
Authorization: Bearer ulUw_8H17EAefCbQ1LEvDAutz6GV5PtDpTgJBScNzM4

Parameters

Name Description
account_id The account ID containing the team you want to retrieve
id The ID of the team you want to retrieve

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 11,
  "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/1120/teams/13" -d '{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2490,"lead":true}]}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer L-BP3iHLcTjWt0A6VnZi7QDZykak2W9sacV1CbNI-_I" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/teams/:id

PUT /1.1/1120/teams/13
Accept: application/json
Content-Type: application/json
Authorization: Bearer L-BP3iHLcTjWt0A6VnZi7QDZykak2W9sacV1CbNI-_I

Parameters

{"name":null,"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":2490,"lead":true}]}}
Name Description
name required Specifies the team name
emoji Specifies the emoji url for a team
color Specifies the project color for a team
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)
users required Specific users with their role in the team. Ex: users:[{'user_id': 1, 'lead': true}]

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 13,
  "name": "Backend",
  "color": "67a3bc",
  "emoji": "http://path.to/emoji.png",
  "external_id": null,
  "user_ids": [
    2490
  ],
  "users": [
    {
      "id": 13,
      "user_id": 2490,
      "team_id": 13,
      "lead": true
    }
  ]
}

UserCapacities

Retrieve capacities

See capacities of multiple users in the account

Request

curl -g "https://api.timelyapp.com/1.1/1125/users/capacities" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer yXS-EffpQWnhmGPglel2eIo02Ei6UNv5pXJNm_upi7I" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/capacities

GET /1.1/1125/users/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer yXS-EffpQWnhmGPglel2eIo02Ei6UNv5pXJNm_upi7I

Parameters

Name Description
account_id required Account for which users' capacities are required
user_ids Users whose capacities are required
since Fetch capacities after selected date
until Fetch capacities before selected date

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "user_id": 2500,
    "capacities": [
      {
        "id": null,
        "weekly_capacity": 40.0,
        "daily_capacity": 8.0,
        "weekdays": "MO,TU,WE,TH,FR",
        "total_working_days": null,
        "weekly_working_days": 5,
        "current": true,
        "start_date": "1970-01-01",
        "end_date": null
      }
    ]
  }
]

Retrieve user's capacities

Using the user id one can see the user's capacities

Request

curl -g "https://api.timelyapp.com/1.1/1124/users/2498/capacities" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WcFWSUnmI-rA-eGhSWNccTv0vUAm82WCprnxfQQ4mP0" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/:user_id/capacities

GET /1.1/1124/users/2498/capacities
Accept: application/json
Content-Type: application/json
Authorization: Bearer WcFWSUnmI-rA-eGhSWNccTv0vUAm82WCprnxfQQ4mP0

Parameters

Name Description
account_id required Account for which user's capacities are required
user_id required User whose capacities are required

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": null,
    "weekly_capacity": 40.0,
    "daily_capacity": 8.0,
    "weekdays": "MO,TU,WE,TH,FR",
    "total_working_days": null,
    "weekly_working_days": 5,
    "current": true,
    "start_date": "1970-01-01",
    "end_date": null
  }
]

Users

An account can have multiple users associated with it. All users have a specific access level, and are usually created by an employer on behalf of an employee.

Create/Invite a user

Note: user_level can have values “normal” or “limited”. A user’s name and email can only be updated by the user themself.

Request

curl "https://api.timelyapp.com/1.1/1127/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":747,"hour_rate":10}]},"name":null,"admin":{"id":496,"email":"notifications@timelyapp.com","created_at":"2021-02-11T05:44:33.000+01:00","updated_at":"2021-02-11T05:44:33.000+01:00","name":"Timely","notifier":false}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Ey8lVecY1OPPlbrWV76ypgozCJEyJJnPs70YIjRtc2A" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/users

POST /1.1/1127/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer Ey8lVecY1OPPlbrWV76ypgozCJEyJJnPs70YIjRtc2A

Parameters

{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":747,"hour_rate":10}]},"name":null,"admin":{"id":496,"email":"notifications@timelyapp.com","created_at":"2021-02-11T05:44:33.000+01:00","updated_at":"2021-02-11T05:44:33.000+01:00","name":"Timely","notifier":false}}
Name Description
user required User attributes
name required Specifies the user name
email required Specifies the user email
projects Description: Specifies the projects that the user will be part of. For example: "projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }]
role_id required Specifies the user's role in the account
user_level (Deprecated) Specifies the user level; either “normal” or “limited”. The default is "normal". For example: "user_level": "normal"
admin (Deprecated) Specifies the user is an admin. In this case user_level should be “normal”. For example: "admin": "true"
external_id The external_id can be used to reference external resource IDs to Timely resources, and should be alphanumeric (max. 512 characters)
weekly_capacity Specifies the user's weekly hour capacity. The default is account's weekly capacity. To avoid rounding issues, values are allowed upto 1 decimal place and divisible by 5.
add_to_all_projects Specifies whether the user should be added to all projects in the account. For example: "add_to_all_projects":true

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 2506,
  "email": "marija@timely.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": false,
  "memory_onboarded": false,
  "created_at": 1613018673,
  "updated_at": 1613018673,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Etc/UTC",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
  },
  "type": "User",
  "weekly_capacity": 40.0,
  "user_level": "manager",
  "admin": false,
  "hide_hourly_rate": false,
  "deleted": false,
  "default_hour_rate": 0.0,
  "role_id": 3380,
  "role": {
    "id": 3380,
    "name": "manager"
  }
}

Delete a user

Request

curl "https://api.timelyapp.com/1.1/1128/users/2507" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer IyLyirYkDvFVY7atVgz3cU5wnRt4RSzxQ8gKghe6g7s" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/users/:id

DELETE /1.1/1128/users/2507
Accept: application/json
Content-Type: application/json
Authorization: Bearer IyLyirYkDvFVY7atVgz3cU5wnRt4RSzxQ8gKghe6g7s

Parameters

Name Description
account_id The account ID containing the user you want to delete
id The ID of the user you want to delete

Response

Content-Type: application/json; charset=utf-8
200 OK
{
}

List all users

Note: The user list will return the 10 most recently updated users.

Request

curl -g "https://api.timelyapp.com/1.1/1131/users" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ZNVTRfBEAX-jAgRqyswE0DQZE7Pf4e97ZS-P37VyFPI" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users

GET /1.1/1131/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer ZNVTRfBEAX-jAgRqyswE0DQZE7Pf4e97ZS-P37VyFPI

Parameters

Name Description
account_id The account ID containing the users you want to retrieve
limit Retrieve a limited number of users
offset Retrieve users from offset
order Sorting order on updated_at
filter Filter users - Ex: filter=deleted

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 2513,
    "email": "marijalkfzfoob@timelyapp.com",
    "name": "Marija Petrovic",
    "active": false,
    "day_view_onboarded": true,
    "memory_onboarded": true,
    "created_at": 1613018675,
    "updated_at": 1613018675,
    "last_received_memories_date": null,
    "sign_in_count": null,
    "external_id": null,
    "time_zone": "Europe/Paris",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/5472f6b6cc9d1eca4078a3c62cafdc9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/5472f6b6cc9d1eca4078a3c62cafdc9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
      "medium_retina": "https://www.gravatar.com/avatar/5472f6b6cc9d1eca4078a3c62cafdc9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/5472f6b6cc9d1eca4078a3c62cafdc9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
      "small_retina": "https://www.gravatar.com/avatar/5472f6b6cc9d1eca4078a3c62cafdc9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
      "small": "https://www.gravatar.com/avatar/5472f6b6cc9d1eca4078a3c62cafdc9d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
    },
    "type": "User",
    "weekly_capacity": 40.0,
    "user_level": "admin",
    "admin": true,
    "hide_hourly_rate": false,
    "deleted": false,
    "default_hour_rate": 0.0,
    "role_id": 3391,
    "role": {
      "id": 3391,
      "name": "admin"
    }
  }
]

Retrieve a user

Request

curl -g "https://api.timelyapp.com/1.1/1129/users/2509" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer q8hQsdoWJN7h7D8sVy594kFL_Hob_aoLlPTa6cV4Fc8" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/:id

GET /1.1/1129/users/2509
Accept: application/json
Content-Type: application/json
Authorization: Bearer q8hQsdoWJN7h7D8sVy594kFL_Hob_aoLlPTa6cV4Fc8

Parameters

Name Description
account_id The account ID containing the users you want to retrieve
id The ID of the user you want to retrieve

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 2509,
  "email": "marijaewikueoj@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1613018674,
  "updated_at": 1613018674,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Europe/Paris",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/beb72ae571db95975b4704be8d5808c3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/beb72ae571db95975b4704be8d5808c3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/beb72ae571db95975b4704be8d5808c3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/beb72ae571db95975b4704be8d5808c3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/beb72ae571db95975b4704be8d5808c3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/beb72ae571db95975b4704be8d5808c3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
  },
  "type": "User",
  "weekly_capacity": 40.0,
  "user_level": "admin",
  "admin": true,
  "hide_hourly_rate": false,
  "deleted": false,
  "default_hour_rate": 0.0,
  "role_id": 3385,
  "role": {
    "id": 3385,
    "name": "admin"
  }
}

Retrieve current user

Request

curl -g "https://api.timelyapp.com/1.1/1130/users/current" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer lB3pJ5LSqYgrPJu9IaRA1v4rvq2IyPUwsPYNm2peCkk" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/current

GET /1.1/1130/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer lB3pJ5LSqYgrPJu9IaRA1v4rvq2IyPUwsPYNm2peCkk

Parameters

Name Description
account_id The account ID containing the current user

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 2511,
  "email": "marijaymmygslz@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1613018674,
  "updated_at": 1613018674,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Europe/Paris",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/b9896b0172bf47f46f8f6c0fecfc8aff?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/b9896b0172bf47f46f8f6c0fecfc8aff?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/b9896b0172bf47f46f8f6c0fecfc8aff?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/b9896b0172bf47f46f8f6c0fecfc8aff?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/b9896b0172bf47f46f8f6c0fecfc8aff?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/b9896b0172bf47f46f8f6c0fecfc8aff?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
  },
  "type": "User",
  "weekly_capacity": 40.0,
  "user_level": "admin",
  "admin": true,
  "hide_hourly_rate": false,
  "deleted": false,
  "default_hour_rate": 0.0,
  "role_id": 3388,
  "role": {
    "id": 3388,
    "name": "admin"
  }
}

Update a user

Note:

Please use the parameters mentioned in “Create/Invite a user”.

Only admins can edit “user_level” and “projects” fields for other users.

Admins can update other users’ profiles. Limited users can only update their own profile.

Request

curl "https://api.timelyapp.com/1.1/1132/users/2515" -d '{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":752,"hour_rate":10}]},"admin":{"id":501,"email":"notifications@timelyapp.com","created_at":"2021-02-11T05:44:36.000+01:00","updated_at":"2021-02-11T05:44:36.000+01:00","name":"Timely","notifier":false}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer muInm_nxo0KFaZUuLlz13GO8aDX4KzSOHtrv_S05_b4" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/users/:id

PUT /1.1/1132/users/2515
Accept: application/json
Content-Type: application/json
Authorization: Bearer muInm_nxo0KFaZUuLlz13GO8aDX4KzSOHtrv_S05_b4

Parameters

{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":752,"hour_rate":10}]},"admin":{"id":501,"email":"notifications@timelyapp.com","created_at":"2021-02-11T05:44:36.000+01:00","updated_at":"2021-02-11T05:44:36.000+01:00","name":"Timely","notifier":false}}
Name Description
id required the numerical ID of the user
user required Label attributes
projects Specifies the projects that the user will be part of. For example: "projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }]
role_id required Specifies the user's role in the account
user_level (Deprecated) Specifies the user level; either “normal” or “limited”. The default is "normal". For example: "user_level": "normal"
admin (Deprecated) Specifies the user is an admin. In this case user_level should be “normal”. For example: "admin": "true"
weekly_capacity Specifies the user's weekly hour capacity. The default is the account's weekly capacity. To avoid rounding issues, values are allowed upto 1 decimal place and divisible by 5.
add_to_all_projects Specifies whether the user should be added to all projects in the account. For example: "add_to_all_projects":true

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 2515,
  "email": "marijagbiaozou@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1613018676,
  "updated_at": 1613018676,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Europe/Paris",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/bf1d6ccb9aed2593428587d70e2af8ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/bf1d6ccb9aed2593428587d70e2af8ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-c403e04ad44c7d8b8c7904dc7e7c1893101f3672565370034edbe3dee9985509.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/bf1d6ccb9aed2593428587d70e2af8ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/bf1d6ccb9aed2593428587d70e2af8ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/bf1d6ccb9aed2593428587d70e2af8ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/bf1d6ccb9aed2593428587d70e2af8ba?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-459a8b7582a7417f4b47a0064f692ffcd161fb11eda9dcc359f1b5e63fe51235.jpg&s=25"
  },
  "type": "User",
  "weekly_capacity": 40.0,
  "user_level": "manager",
  "admin": false,
  "hide_hourly_rate": false,
  "deleted": false,
  "default_hour_rate": 0.0,
  "role_id": 3395,
  "role": {
    "id": 3395,
    "name": "manager"
  }
}

Errors

Example responses:

422 Unprocessable Entity
{
  "errors":{
    "name":[
      "can't be blank"
    ],
    "project_users":[
      "is invalid"
    ]
  }
}
422 Unprocessable Entity
403 Forbidden
{
  "errors":{
    "message":"error message"
  }
}
404 Not Found
{
  "errors":{
    "message":"Not Found"
  }
}
401 Unauthorized
{
  "errors":{
    "message":"Unauthorized"
  }
}

Timely uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed due to the information provided. Codes in the 5xx range indicate an error with Timely's servers.

Unauthorized access o projects and accounts, or trying to create or delete objects that are not under our control, will result in errors.

The Timely API uses the following error codes:

Error Code Meaning
400 - Bad Request Your request is invalid
401 - Unauthorized Wrong authentication token was used
403 - Forbidden The entity requested is hidden from unauthorized access
404 - Not Found The specified entity could not be found
422 - Unprocessable Entity The server understands the content type, but was unable to process the request
500 - Internal Server Error We’re experiencing a problem with our server. Try again later.