NAV Navbar
cURL

Introduction

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

Authentication

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

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

Enter your application name and the redirect_url to your application.

Acquire the Application Id and Secret.

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

Authorization

OAuth Code

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

Users are redirected to request their Timely identity.

HTTP Request

GET /oauth/authorize

Compulsory Parameters

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

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

OAuth Token

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

Users are redirected to request their Timely identity.

HTTP Request

POST /oauth/token

Compulsory Parameters

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

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

Use Timely API to integrate with your apps

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

Accounts

List all account

Returns all accounts created within one email address.

Request

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

Endpoint

GET /1.1/accounts

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

Parameters

None known.

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 15,
    "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-9aefd4c1fb903fb750d36f1b1cc64dc01eb578efd2fd0eb5311344082d6d036e.png",
      "medium_retina": "/assets/account_thumbs/account_medium_retina-3e55e5ac5ba6b1d8077c1e329691e55032a5831997c9e712998594192d534fdf.png",
      "small_retina": "/assets/account_thumbs/account_small_retina-1b8bfb705765064d856161ba9daa1d52155f181c330ac6fe9b5e2f366adaf4fe.png"
    },
    "from": "Web",
    "max_users": 0,
    "max_projects": 0,
    "num_users": 1,
    "num_projects": 0,
    "plan_id": 15,
    "plan_name": "Essential",
    "next_charge": "2019-12-20",
    "start_of_week": 0,
    "created_at": 1574253187,
    "payment_mode": "web",
    "paid": true,
    "company_size": "10-49",
    "plan_code": "essential",
    "appstore_transaction_id": null,
    "owner_id": 40,
    "capacity": {
      "hours": 40.0,
      "minutes": 0.0,
      "seconds": 0.0,
      "formatted": "40:00",
      "total_hours": 40.0,
      "total_seconds": 144000.0,
      "total_minutes": 2400.0
    },
    "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": "priority_support",
        "days": -1
      },
      {
        "name": "planning",
        "days": -1
      },
      {
        "name": "people_dashboard",
        "days": -1
      },
      {
        "name": "people_notify",
        "days": -1
      }
    ]
  }
]

Retrieve an account

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

Request

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

Endpoint

GET /1.1/accounts/:id

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

Parameters

Name Description
id The id of the account to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 14,
  "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-9aefd4c1fb903fb750d36f1b1cc64dc01eb578efd2fd0eb5311344082d6d036e.png",
    "medium_retina": "/assets/account_thumbs/account_medium_retina-3e55e5ac5ba6b1d8077c1e329691e55032a5831997c9e712998594192d534fdf.png",
    "small_retina": "/assets/account_thumbs/account_small_retina-1b8bfb705765064d856161ba9daa1d52155f181c330ac6fe9b5e2f366adaf4fe.png"
  },
  "from": "Web",
  "max_users": 0,
  "max_projects": 0,
  "num_users": 1,
  "num_projects": 0,
  "plan_id": 14,
  "plan_name": "Essential",
  "next_charge": "2019-12-20",
  "start_of_week": 0,
  "created_at": 1574253187,
  "payment_mode": "web",
  "paid": true,
  "company_size": "10-49",
  "plan_code": "essential",
  "appstore_transaction_id": null,
  "owner_id": 38,
  "capacity": {
    "hours": 40.0,
    "minutes": 0.0,
    "seconds": 0.0,
    "formatted": "40:00",
    "total_hours": 40.0,
    "total_seconds": 144000.0,
    "total_minutes": 2400.0
  },
  "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": "priority_support",
      "days": -1
    },
    {
      "name": "planning",
      "days": -1
    },
    {
      "name": "people_dashboard",
      "days": -1
    },
    {
      "name": "people_notify",
      "days": -1
    }
  ]
}

Retrieve the activities

This endpoint shows you all activities done by you and/or the members that you have permission to see upon, such as: logging hours, create a report, share a report and similar activities.

Request

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

Endpoint

GET /1.1/:account_id/activities

GET /1.1/13/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer jEP9lVhJwGtjrFBrq0v8Zx0MN5gctRTTk9qzoXeb80c

Parameters

Name Description
account_id The id of the account to be retrieved

Response

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

]

Clients

A client can be a company which user works for. User can have multiple companies/clients.

Create a client

This api allows you to create a client for an account.

Request

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

Endpoint

POST /1.1/:account_id/clients

POST /1.1/37/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1nYgGJi7yo9FouqmswEcc81KI2UW6qAmeCf6qSAXBxU

Parameters

{"client":{"name":"Timely","active":true}}
Name Description
name required Specifies the client name
active Change the client state to archived if set to true. Example values: true or false
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 29,
  "name": "Timely",
  "active": true,
  "external_id": null,
  "updated_at": "2019-11-20T13:33:26+01:00"
}

List all clients

This api will return the list of all clients details created for one account.

NOTE: Client list will return recently updated 10 clients.

Request

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

Endpoint

GET /1.1/:account_id/clients

GET /1.1/38/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer NV_zWb0WMQRTMNS4bXPq58GYURnoMbNGoDLWZoPx13M

Parameters

Name Description
account_id Account id for which clients to be retrieved
show Specifies which records to retrieve, default is current accounts active clients (show=active). Example: "show=all" or "show=active" or "show=archived"

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 30,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-20T13:33:27+01:00"
  }
]

Update a client

Using a client's id one can update client details.

Request

curl "https://api.timelyapp.com/1.1/39/clients/31" -d '{"client":{"name":"Updated name","active":true}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer RnR6mQQMdANbA_-wjuSu-0R3800cJj1qqr1kxMWOphU" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/clients/:id

PUT /1.1/39/clients/31
Accept: application/json
Content-Type: application/json
Authorization: Bearer RnR6mQQMdANbA_-wjuSu-0R3800cJj1qqr1kxMWOphU

Parameters

{"client":{"name":"Updated name","active":true}}
Name Description
id required Client id
name required Specifies the client name
active Change the client state to archived if set to true. Example values: true or false
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 31,
  "name": "Updated name",
  "active": true,
  "external_id": null,
  "updated_at": "2019-11-20T13:33:28+01:00"
}

Events

Evens represent all entries made by user. A user can add, delete and edit all entries. Limited users might have less privileges.

Create an event

Logged in user creating an event for self.

Note: By default the event is created for user’s last hour project or the first active project.

Request

curl "https://api.timelyapp.com/1.1/56/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-20T13:33:33.303+01:00","to":"2019-11-20T17:03:33.303+01:00","day":"2019-11-20","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":36}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer kTJJwjYNxsTeptgIu196lQksv9QB1CCEJI3-8_S4YuY" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/events

POST /1.1/56/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer kTJJwjYNxsTeptgIu196lQksv9QB1CCEJI3-8_S4YuY

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-20T13:33:33.303+01:00","to":"2019-11-20T17:03:33.303+01:00","day":"2019-11-20","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":36}}
Name Description
day required Event day
hours required Event hours
minutes required Event minutes
estimated_minutes Specifies the event estimated minutes. Example Values: 0-60
estimated_hours Specifies the event estimated hours. Example Values: 0-12
note Specifies the event notes.
from Specifies the from time. Example Values: from: "2017-05-26T10:00:00+05:30"
to Specifies the to time. Example Values: to: "2017-05-26T12:00:00+05:30"
label_ids Specifies the label_ids. Example Values: label_ids:[2,3,4], label_ids should be part of project labels if defined
project_id Specifies the project id
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 78,
  "uid": "35f4a8d465e6e1edc05f3d8ab658c551",
  "user": {
    "id": 127,
    "email": "marijacdhqyydg@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/5c561629bca2ab725b5d57db2e9ae4a5?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/5c561629bca2ab725b5d57db2e9ae4a5?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/5c561629bca2ab725b5d57db2e9ae4a5?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:32+01:00"
  },
  "project": {
    "id": 36,
    "active": true,
    "account_id": 56,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253213,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 37,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:33+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 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": "2019-11-20",
  "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": 1574253213,
  "created_at": 1574253213,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:33+01:00",
  "from": "2019-11-20T13:33:33+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 127,
  "updater_id": 127,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Create an event for a project

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

Request

curl "https://api.timelyapp.com/1.1/55/projects/35/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-20T13:33:32.527+01:00","to":"2019-11-20T17:03:32.527+01:00","day":"2019-11-20","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":35}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WLHlJyBu4lvsAPvbfSVk2koay1kEAvMVvn9LimFP6Q0" \
    -H "Cookie: "

Endpoint

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

POST /1.1/55/projects/35/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer WLHlJyBu4lvsAPvbfSVk2koay1kEAvMVvn9LimFP6Q0

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-20T13:33:32.527+01:00","to":"2019-11-20T17:03:32.527+01:00","day":"2019-11-20","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","project_id":35}}
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": 77,
  "uid": "28dd2c7955ce926456240b2ff0100bde",
  "user": {
    "id": 125,
    "email": "marijakvkqrmbk@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/1c60918e39b688313437be2287865653?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/1c60918e39b688313437be2287865653?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/1c60918e39b688313437be2287865653?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:32+01:00"
  },
  "project": {
    "id": 35,
    "active": true,
    "account_id": 55,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253212,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 36,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:32+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 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": "2019-11-20",
  "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": 1574253212,
  "created_at": 1574253212,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:32+01:00",
  "from": "2019-11-20T13:33:32+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 125,
  "updater_id": 125,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Create an event for another user

Note: Normal user can add hours for any user. If project_id is not provided, the event is created for user’s last hour project or the first active project.

Request

curl "https://api.timelyapp.com/1.1/54/users/123/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-20T13:33:31.839+01:00","to":"2019-11-20T17:03:31.839+01:00","day":"2019-11-20","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":123}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer _HkZovrM3DsnWS8PHdU4M-WMI-ZjyOtcvFTMh28HNfM" \
    -H "Cookie: "

Endpoint

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

POST /1.1/54/users/123/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer _HkZovrM3DsnWS8PHdU4M-WMI-ZjyOtcvFTMh28HNfM

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-20T13:33:31.839+01:00","to":"2019-11-20T17:03:31.839+01:00","day":"2019-11-20","note":"Notes for testing with some random #hash in it.","billed":false,"hour_rate":100,"timer_state":0,"created_from":"Web","updated_from":"Web","user_id":123}}
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": 76,
  "uid": "fbd7939d674997cdb4692d34de8633c4",
  "user": {
    "id": 123,
    "email": "marijaykowyekd@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/84652e11baf6ca9905fe94d7f86a1da4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/84652e11baf6ca9905fe94d7f86a1da4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/84652e11baf6ca9905fe94d7f86a1da4?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:31+01:00"
  },
  "project": {
    "id": 34,
    "active": true,
    "account_id": 54,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253211,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 35,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:31+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 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": "2019-11-20",
  "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": 1574253211,
  "created_at": 1574253211,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:31+01:00",
  "from": "2019-11-20T13:33:31+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 123,
  "updater_id": 123,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Delete an event

Note: Normal user can delete events of other projects of same account. Limited user can delete only his events.

Request

curl "https://api.timelyapp.com/1.1/57/events/79" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 2bHc1pdB2IPkJgOAZAjQzCIuxQYV5RApsULS09weuEk" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/events/:id

DELETE /1.1/57/events/79
Accept: application/json
Content-Type: application/json
Authorization: Bearer 2bHc1pdB2IPkJgOAZAjQzCIuxQYV5RApsULS09weuEk

Parameters

Name Description
account_id Account id for which hour to be deleted
id required The id of the hour to be deleted

Response

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

List all events

Get all the events of active projects present in user’s account.

Note: If “since” and “upto” parameters are not passed, default period is current day.

Request

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

Endpoint

GET /1.1/:account_id/events

GET /1.1/59/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer nHYFTn5n_jRxHB3anqU60oRWB0YeAjraYRoZ0MgbU6g

Parameters

Name Description
account_id Account id for which hours to be retrieved
since Specifies the start date for results to return. Example: since=2014-08-18
upto Specifies the end date for results to return. Example: upto=2014-08-24
day Specifies the day date for results to return. Example: day=2014-08-24

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 81,
    "uid": "43ec517d68b6edd3015b3edc9a11367b",
    "user": {
      "id": 133,
      "email": "marijarfqnlboz@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "timeline": "https://www.gravatar.com/avatar/f6ab7bfb6751a0805d5259b2f3eb5cfb?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/f6ab7bfb6751a0805d5259b2f3eb5cfb?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/f6ab7bfb6751a0805d5259b2f3eb5cfb?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
      },
      "updated_at": "2019-11-20T13:33:34+01:00"
    },
    "project": {
      "id": 39,
      "active": true,
      "account_id": 59,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1574253214,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 40,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2019-11-20T13:33:34+01:00"
      },
      "required_notes": false,
      "budget": 0,
      "budget_type": "",
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "labels": [

      ],
      "label_ids": [

      ],
      "required_label_ids": [

      ]
    },
    "duration": {
      "hours": 3,
      "minutes": 30,
      "seconds": 0,
      "formatted": "03:30",
      "total_hours": 3.5,
      "total_seconds": 12600,
      "total_minutes": 210
    },
    "estimated_duration": {
      "hours": 4,
      "minutes": 0,
      "seconds": 0,
      "formatted": "04:00",
      "total_hours": 4.0,
      "total_seconds": 14400,
      "total_minutes": 240
    },
    "cost": {
      "fractional": 17500,
      "formatted": "$175.00",
      "amount": 175.0
    },
    "estimated_cost": {
      "fractional": 20000,
      "formatted": "$200.00",
      "amount": 200.0
    },
    "day": "2019-11-20",
    "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": 1574253214,
    "created_at": 1574253214,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2019-11-20T17:03:34+01:00",
    "from": "2019-11-20T13:33:34+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
  }
]

List all events for project

Note: Only normal user can get events of other projects of same account. Limited user can only get events of his own project.

Request

curl -g "https://api.timelyapp.com/1.1/61/projects/41/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Mup8bGEdkPF8UewcVwgm3-XAfDMsIoUBJI7lHacfzgw" \
    -H "Cookie: "

Endpoint

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

GET /1.1/61/projects/41/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer Mup8bGEdkPF8UewcVwgm3-XAfDMsIoUBJI7lHacfzgw

Parameters

Name Description
account_id Account id for which hours to be retrieved
project_id Project id for which hours to be retrieved
since Specifies the start date for results to return. Example: since=2014-08-18
upto Specifies the end date for results to return. Example: upto=2014-08-24
day Specifies the day date for results to return. Example: day=2014-08-24

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 83,
    "uid": "fe9fc289c3ff0af142b6d3bead98a923",
    "user": {
      "id": 137,
      "email": "marijaztcektue@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "timeline": "https://www.gravatar.com/avatar/091d5985a20aef7b9913ee7000e1768e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/091d5985a20aef7b9913ee7000e1768e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/091d5985a20aef7b9913ee7000e1768e?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
      },
      "updated_at": "2019-11-20T13:33:35+01:00"
    },
    "project": {
      "id": 41,
      "active": true,
      "account_id": 61,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1574253216,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 42,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2019-11-20T13:33:35+01:00"
      },
      "required_notes": false,
      "budget": 0,
      "budget_type": "",
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "labels": [

      ],
      "label_ids": [

      ],
      "required_label_ids": [

      ]
    },
    "duration": {
      "hours": 3,
      "minutes": 30,
      "seconds": 0,
      "formatted": "03:30",
      "total_hours": 3.5,
      "total_seconds": 12600,
      "total_minutes": 210
    },
    "estimated_duration": {
      "hours": 4,
      "minutes": 0,
      "seconds": 0,
      "formatted": "04:00",
      "total_hours": 4.0,
      "total_seconds": 14400,
      "total_minutes": 240
    },
    "cost": {
      "fractional": 17500,
      "formatted": "$175.00",
      "amount": 175.0
    },
    "estimated_cost": {
      "fractional": 20000,
      "formatted": "$200.00",
      "amount": 200.0
    },
    "day": "2019-11-20",
    "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": 1574253216,
    "created_at": 1574253216,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2019-11-20T17:03:36+01:00",
    "from": "2019-11-20T13:33:36+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
  }
]

List all events for user

Note: Only normal user can get events of other users of same account. Limited user will always get his one events.

Request

curl -g "https://api.timelyapp.com/1.1/60/users/135/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 5I00QMmrcmiUy3pEfJNncsvuoEVVOePPceDFJkukPdE" \
    -H "Cookie: "

Endpoint

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

GET /1.1/60/users/135/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 5I00QMmrcmiUy3pEfJNncsvuoEVVOePPceDFJkukPdE

Parameters

Name Description
account_id Account id for which hours to be retrieved
user_id User id for which hours to be retrieved
since Specifies the start date for results to return. Example: since=2014-08-18
upto Specifies the end date for results to return. Example: upto=2014-08-24
day Specifies the day date for results to return. Example: day=2014-08-24

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 82,
    "uid": "9778d5d219c5080b9a6a17bef029331c",
    "user": {
      "id": 135,
      "email": "marijakjbegdys@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "timeline": "https://www.gravatar.com/avatar/affa1659c58b17e4ea1fd454e9e4fc7f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/affa1659c58b17e4ea1fd454e9e4fc7f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/affa1659c58b17e4ea1fd454e9e4fc7f?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
      },
      "updated_at": "2019-11-20T13:33:35+01:00"
    },
    "project": {
      "id": 40,
      "active": true,
      "account_id": 60,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1574253215,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 41,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2019-11-20T13:33:35+01:00"
      },
      "required_notes": false,
      "budget": 0,
      "budget_type": "",
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "labels": [

      ],
      "label_ids": [

      ],
      "required_label_ids": [

      ]
    },
    "duration": {
      "hours": 3,
      "minutes": 30,
      "seconds": 0,
      "formatted": "03:30",
      "total_hours": 3.5,
      "total_seconds": 12600,
      "total_minutes": 210
    },
    "estimated_duration": {
      "hours": 4,
      "minutes": 0,
      "seconds": 0,
      "formatted": "04:00",
      "total_hours": 4.0,
      "total_seconds": 14400,
      "total_minutes": 240
    },
    "cost": {
      "fractional": 17500,
      "formatted": "$175.00",
      "amount": 175.0
    },
    "estimated_cost": {
      "fractional": 20000,
      "formatted": "$200.00",
      "amount": 200.0
    },
    "day": "2019-11-20",
    "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": 1574253215,
    "created_at": 1574253215,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2019-11-20T17:03:35+01:00",
    "from": "2019-11-20T13:33:35+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
  }
]

Logged in user updating details and user of an event

Note: Normal user can edit event’s user to one of his account’s user. Limited user can not edit user.

Request

curl "https://api.timelyapp.com/1.1/66/users/147/events/88" -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 XofOSlwCNL0U2POqSvkC-zf8g55wXWSo9OkJOkGRmpU" \
    -H "Cookie: "

Endpoint

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

PUT /1.1/66/users/147/events/88
Accept: application/json
Content-Type: application/json
Authorization: Bearer XofOSlwCNL0U2POqSvkC-zf8g55wXWSo9OkJOkGRmpU

Parameters

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

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 88,
  "uid": "2a38a4a9316c49e5a833517c45d31070",
  "user": {
    "id": 147,
    "email": "marijaaczcukbo@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/34081b616daec69638798fe3c828bb87?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/34081b616daec69638798fe3c828bb87?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/34081b616daec69638798fe3c828bb87?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:38+01:00"
  },
  "project": {
    "id": 46,
    "active": true,
    "account_id": 66,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253219,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 47,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:39+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 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": "2019-11-20",
  "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": 1574253219,
  "created_at": 1574253219,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:39+01:00",
  "from": "2019-11-20T13:33:39+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 147,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Loggedin user updating details and project of his event

Request

curl "https://api.timelyapp.com/1.1/65/projects/45/events/87" -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 80f2stJExvTv1YsaPwlGM0XWP10gYrPjw5PnpLi2hh8" \
    -H "Cookie: "

Endpoint

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

PUT /1.1/65/projects/45/events/87
Accept: application/json
Content-Type: application/json
Authorization: Bearer 80f2stJExvTv1YsaPwlGM0XWP10gYrPjw5PnpLi2hh8

Parameters

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

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 87,
  "uid": "c7e1249ffc03eb9ded908c236bd1996d",
  "user": {
    "id": 145,
    "email": "marijaskmvycep@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/78a131f2017d1382dcbe1fd5eace1d06?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/78a131f2017d1382dcbe1fd5eace1d06?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/78a131f2017d1382dcbe1fd5eace1d06?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:38+01:00"
  },
  "project": {
    "id": 45,
    "active": true,
    "account_id": 65,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253218,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 46,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:38+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 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": "2019-11-20",
  "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": 1574253218,
  "created_at": 1574253218,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:38+01:00",
  "from": "2019-11-20T13:33:38+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 145,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Retrieve an event

Request

curl -g "https://api.timelyapp.com/1.1/58/events/80" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer JovHn0BE9iGIXDlK6x1i9V3WHLxXX-3iDe6BLjqnKb0" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/events/:id

GET /1.1/58/events/80
Accept: application/json
Content-Type: application/json
Authorization: Bearer JovHn0BE9iGIXDlK6x1i9V3WHLxXX-3iDe6BLjqnKb0

Parameters

Name Description
account_id Account id for which hour to be retrieved
id The id of the hour to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 80,
  "uid": "f033ab37c30201f73f142449d037028d",
  "user": {
    "id": 131,
    "email": "marijajsjnsatv@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/96a7a869077b9425f1eb7c20d9d3f7a1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/96a7a869077b9425f1eb7c20d9d3f7a1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/96a7a869077b9425f1eb7c20d9d3f7a1?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:33+01:00"
  },
  "project": {
    "id": 38,
    "active": true,
    "account_id": 58,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253214,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 39,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:34+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 3,
    "minutes": 30,
    "seconds": 0,
    "formatted": "03:30",
    "total_hours": 3.5,
    "total_seconds": 12600,
    "total_minutes": 210
  },
  "estimated_duration": {
    "hours": 4,
    "minutes": 0,
    "seconds": 0,
    "formatted": "04:00",
    "total_hours": 4.0,
    "total_seconds": 14400,
    "total_minutes": 240
  },
  "cost": {
    "fractional": 17500,
    "formatted": "$175.00",
    "amount": 175.0
  },
  "estimated_cost": {
    "fractional": 20000,
    "formatted": "$200.00",
    "amount": 200.0
  },
  "day": "2019-11-20",
  "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": 1574253214,
  "created_at": 1574253214,
  "created_from": "Web",
  "updated_from": "Web",
  "billed": false,
  "to": "2019-11-20T17:03:34+01:00",
  "from": "2019-11-20T13:33:34+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
}

Start timer on event

Request

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

Endpoint

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

PUT /1.1/62/events/84/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer -urmBvXg1YpB5LItXobEconfDVlLjfqI8u4o_9UZt9E

Parameters

Name Description
id required Event id

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 84,
  "uid": "68d30a9594728bc39aa24be94b319d21",
  "user": {
    "id": 139,
    "email": "marijawxaqkcoe@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/e7a4b34bafd5130ec0e6fb37b8f97f01?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/e7a4b34bafd5130ec0e6fb37b8f97f01?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/e7a4b34bafd5130ec0e6fb37b8f97f01?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:36+01:00"
  },
  "project": {
    "id": 42,
    "active": true,
    "account_id": 62,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253216,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 43,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:36+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

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

  ],
  "user_ids": [

  ],
  "updated_at": 1574253216,
  "created_at": 1574253216,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:36+01:00",
  "from": "2019-11-20T13:33:36+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 139,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Stop timer on event

Request

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

Endpoint

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

PUT /1.1/63/events/85/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer h6FdFrQ2rytDNKPv2u71mTbN6X9G-HVuDXZkMb54IOA

Parameters

Name Description
id required Event id

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 85,
  "uid": "3ef815416f775098fe977004015c6193",
  "user": {
    "id": 141,
    "email": "marijayoxhjxcv@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/4ce2633992669d8f57e2bb16bfb14b12?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/4ce2633992669d8f57e2bb16bfb14b12?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/4ce2633992669d8f57e2bb16bfb14b12?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:37+01:00"
  },
  "project": {
    "id": 43,
    "active": true,
    "account_id": 63,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253217,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 44,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:37+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

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

  ],
  "user_ids": [

  ],
  "updated_at": 1574253217,
  "created_at": 1574253217,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:37+01:00",
  "from": "2019-11-20T13:33:37+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 141,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Update an event

Logged in user updating self event

Note: If its a normal user then he can edit events of other users of his account. Also the project_id can be edited to one from his account. If limited user, then he can edit only his events.

Request

curl "https://api.timelyapp.com/1.1/64/events/86" -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 X6ZumzaSipTDaQ1iHZPVJByeHzPLlW10iJfJl9iX54k" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/events/:id

PUT /1.1/64/events/86
Accept: application/json
Content-Type: application/json
Authorization: Bearer X6ZumzaSipTDaQ1iHZPVJByeHzPLlW10iJfJl9iX54k

Parameters

{"event":{"note":"Updated notes","minutes":0,"hours":0,"estimated":true,"estimated_minutes":0,"estimated_hours":2}}
Name Description
id required Event id
day required Event day
hours required Event hours
minutes required Event minutes
project_id Project id
estimated_minutes Specifies the event estimated minutes. Example Values: 0-60
estimated_hours Specifies the event estimated hours. Example Values: 0-12
note Specifies the event notes.
from Specifies the from time. Example Values: from: "2017-05-26T10:00:00+05:30"
to Specifies the to time. Example Values: to: "2017-05-26T12:00:00+05:30"
label_ids Specifies the label ids. Example Values: label_ids:[2,3,4]
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 86,
  "uid": "93db85ed909c13838ff95ccfa94cebd9",
  "user": {
    "id": 143,
    "email": "marijaxwtemegq@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/fc1592a1d945b757b788176feb4d9d0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/fc1592a1d945b757b788176feb4d9d0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/fc1592a1d945b757b788176feb4d9d0a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-20T13:33:37+01:00"
  },
  "project": {
    "id": 44,
    "active": true,
    "account_id": 64,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253218,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 45,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:38+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "labels": [

    ],
    "label_ids": [

    ],
    "required_label_ids": [

    ]
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 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": "2019-11-20",
  "note": "Updated notes",
  "sequence": 1,
  "estimated": true,
  "timer_state": "default",
  "timer_started_on": 0,
  "timer_stopped_on": 0,
  "label_ids": [

  ],
  "user_ids": [

  ],
  "updated_at": 1574253218,
  "created_at": 1574253218,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-20T17:03:38+01:00",
  "from": "2019-11-20T13:33:38+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 143,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Labels

Labels/Tags help you classify the work, group related work and also to set some requirements. This api allows you to create, list, update and delete tags created within one account.

Create a label

Request

curl "https://api.timelyapp.com/1.1/69/labels" -d '{"label":{"name":"Web Programming"}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ZRUytPPE7sCIxArqiMU2QnVAx7ygmXhzzZlkRQ-fGPs" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/labels

POST /1.1/69/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer ZRUytPPE7sCIxArqiMU2QnVAx7ygmXhzzZlkRQ-fGPs

Parameters

{"label":{"name":"Web Programming"}}
Name Description
name required Specifies the label name
emoji Specifies the emoji url for label
parent_id Set the parent_id if you want to create child label

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 6,
  "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",
  "children": [

  ]
}

Delete a label

Request

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

Endpoint

DELETE /1.1/:account_id/labels/:id

DELETE /1.1/70/labels/7
Accept: application/json
Content-Type: application/json
Authorization: Bearer qcyIknWAQMvQl0nR93rEPzncmkERjPOzh9_issId7i8

Parameters

Name Description
account_id Account id for which label to be deleted
id The id of the label to be deleted

Response

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

List all child labels

Get all child of given tags present in user’s account.

Request

curl -g "https://api.timelyapp.com/1.1/73/labels?parent_id=9" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer dEpKEjuf0CtpBuaXlKym-2Vceah0zeDMeZ72jlfHDMM" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/labels

GET /1.1/73/labels?parent_id=9
Accept: application/json
Content-Type: application/json
Authorization: Bearer dEpKEjuf0CtpBuaXlKym-2Vceah0zeDMeZ72jlfHDMM

Parameters

parent_id: 9
Name Description
account_id Account id for which label to be retrieved
parent_id The id of the parent label to be retrieved

Response

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

  ]
}

List all label

Get all the tags present in user’s account.

Request

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

Endpoint

GET /1.1/:account_id/labels

GET /1.1/72/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer uId-APZIWCzN38SraKsrB4bFZn5n8BDWdNc3i4I69G0

Parameters

None known.

Response

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

]

Retrieve a label

Get single tags present in user’s account.

Request

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

Endpoint

GET /1.1/:account_id/labels/:id

GET /1.1/71/labels/8
Accept: application/json
Content-Type: application/json
Authorization: Bearer gWE8VtkelIK_NQUBDrFz7fIwv9vkY6fPMXtXt12z4tI

Parameters

Name Description
account_id Account id for which label to be retrieved
id The id of the label to be retrieved

Response

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

  ]
}

Update a label

Request

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

Endpoint

PUT /1.1/:account_id/labels/:id

PUT /1.1/74/labels/10
Accept: application/json
Content-Type: application/json
Authorization: Bearer Q4TheDmfo1hlQHZDkYGDlCTFXjz5Fi_nXxNJE6S8YOI

Parameters

{"label":{"name":"updated name"}}
Name Description
id required Label id
name required Specifies the label name
emoji Specifies the emoji url for tag
parent_id Set the parent_id if you want to create child tags

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 10,
  "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",
  "children": [

  ]
}

Projects

Project object contains all project details of a logged account. With this api you can retrieve a specific project or the list of all projects, update, create and delete a project.

Create a project

Request

curl "https://api.timelyapp.com/1.1/90/projects" -d '{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":67,"budget_type":"M","budget":300,"users":[{"user_id":192}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":11,"required":true},{"label_id":12,"required":true},{"label_id":13,"required":false},{"label_id":14,"required":false}]}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 89fLna8ztHLUJtPB8pukarKgXIaNZHUCLcQsmMEHwA8" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/projects

POST /1.1/90/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer 89fLna8ztHLUJtPB8pukarKgXIaNZHUCLcQsmMEHwA8

Parameters

{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":67,"budget_type":"M","budget":300,"users":[{"user_id":192}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":11,"required":true},{"label_id":12,"required":true},{"label_id":13,"required":false},{"label_id":14,"required":false}]}}
Name Description
project required Project attributes
name required Specifies the project name
color required Specifies the project color, should be one of 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0
client_id required Specifies the numerical client id
users required Specifies the project users, should be array of users with numerical user id and hour_rate Example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }]
billable Specifies the project is billable or not, should be true or false
budget Specifies the budget for project, should be numeric value
hour_rate Specifies the hour rate for project, should be numeric value
rate_type Specifies the hour rate type for project, should be 'user' or 'project'
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters
budget_recurrence It specifies when the recurrence of budget will occur
send_invite Specifies if you want to send project invite email, should be true or false
required_notes Project hours notes to be required for logging
labels Specifies the project labels, should be array of labels with numerical label id and required flag Example: "labels": [{ "label_id": 1, "required": true }, { "label_id": 2, "required": false }]

Response

Content-Type: application/json; charset=utf-8
201 Created
{
  "id": 67,
  "active": true,
  "account_id": 90,
  "name": "New Project",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1574253226,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 67,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-20T13:33:46+01:00"
  },
  "required_notes": false,
  "budget": 300,
  "budget_type": "M",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "users": [
    {
      "user_id": 192,
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "updated_at": "2019-11-20T13:33:46+01:00",
      "deleted": false
    }
  ],
  "labels": [
    {
      "project_id": 67,
      "label_id": 11,
      "budget": null,
      "required": true,
      "updated_at": "2019-11-20T13:33:46+01:00"
    },
    {
      "project_id": 67,
      "label_id": 12,
      "budget": null,
      "required": true,
      "updated_at": "2019-11-20T13:33:46+01:00"
    },
    {
      "project_id": 67,
      "label_id": 13,
      "budget": null,
      "required": false,
      "updated_at": "2019-11-20T13:33:46+01:00"
    },
    {
      "project_id": 67,
      "label_id": 14,
      "budget": null,
      "required": false,
      "updated_at": "2019-11-20T13:33:46+01:00"
    }
  ],
  "label_ids": [
    11,
    12,
    13,
    14
  ],
  "required_label_ids": [
    11,
    12
  ],
  "cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "estimated_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "estimated_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "billed_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "billed_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "unbilled_cost": {
    "fractional": 0,
    "formatted": "$0.00",
    "amount": 0.0
  },
  "unbilled_duration": {
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "formatted": "00:00",
    "total_hours": 0.0,
    "total_seconds": 0,
    "total_minutes": 0
  },
  "first_logged_on": null,
  "last_logged_on": null,
  "budget_recurrence": {
    "recur": "week",
    "start_date": "2018-09-21",
    "end_date": "2019-09-21",
    "recur_until": "end_date",
    "days_count": 365,
    "updated_at": "2019-11-20T13:33:46+01:00"
  }
}

Delete a project

Request

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

Endpoint

DELETE /1.1/:account_id/projects/:id

DELETE /1.1/91/projects/68
Accept: application/json
Content-Type: application/json
Authorization: Bearer rLi9wS9JctwVXTYiIgZEqZ_JNO6mYx3AABQIjpvRQ_Y

Parameters

Name Description
account_id Account id for which project to be deleted
id The id of the project to be deleted

Response

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

List all projects

Note: Normal user will get all the projects from account. Limited user will get only his projects.

Project list will return recently updated 10 projects additionally you can add the “per_page”, “filter” and “order” optional parameters to change the result.

Request

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

Endpoint

GET /1.1/:account_id/projects

GET /1.1/93/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer QJ03r-rJu1LxWMWinmedWEuQAtY0R2dquQQgskrNqXE

Parameters

Name Description
offset Retrieve projects from offset
limit Retrieve number of projects
order Sorting order on updated_at
filter Filter projects - mine, active, archived, all
updated_after Retrieve records updated after a certain timestamp
project_ids Retrieve specific projects

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 70,
    "active": true,
    "account_id": 93,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1574253228,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 70,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-20T13:33:48+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "users": [
      {
        "user_id": 198,
        "hour_rate": 100.0,
        "hour_rate_in_cents": 10000.0,
        "updated_at": "2019-11-20T13:33:48+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 providing a project id.

Request

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

Endpoint

GET /1.1/:account_id/projects/:id

GET /1.1/92/projects/69
Accept: application/json
Content-Type: application/json
Authorization: Bearer tE35DjNZBlSjG7x04jtHVIEFKYytJZoJWiTgYqxo_QU

Parameters

Name Description
account_id Account id for which project to be retrieved
id The id of the project to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 69,
  "active": true,
  "account_id": 92,
  "name": "Timely",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1574253227,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 69,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-20T13:33:47+01:00"
  },
  "required_notes": false,
  "budget": 0,
  "budget_type": "",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "users": [
    {
      "user_id": 196,
      "hour_rate": 100.0,
      "hour_rate_in_cents": 10000.0,
      "updated_at": "2019-11-20T13:33:47+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/95/projects/72" -d '{"project":{"name":"updated project name"}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 1743GLbhGiA-2KWuK5HrSX0_zNf53sJ-eS7OFBswEEo" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/projects/:id

PUT /1.1/95/projects/72
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1743GLbhGiA-2KWuK5HrSX0_zNf53sJ-eS7OFBswEEo

Parameters

{"project":{"name":"updated project name"}}
Name Description
id required Project id
project Project attributes
name required Specifies the project name
color required Specifies the project color, should be one of 47b17c, 67a3bc, bd4c4f, d0915a, 866b9c, cdae4f, 5ab8b7, c697c0
client_id required Specifies the numerical client id
users required Specifies the project users, should be array of users with numerical user id and hour_rate Example: "users": [{ "user_id": 175551, "hour_rate": 25.0 },{ "user_id": 117861, "hour_rate": 27.0 }]
billable Specifies the project is billable or not, should be true or false
budget Specifies the budget for project, should be numeric value
hour_rate Specifies the hour rate for project, should be numeric value
rate_type Specifies the hour rate type for project, should be 'user' or 'project'
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters
send_invite Specifies if you want to send project invite email, should be true or false
required_notes Project hours notes to be required for logging

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 72,
  "active": true,
  "account_id": 95,
  "name": "updated project name",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1574253230,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 72,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-20T13:33:50+01:00"
  },
  "required_notes": false,
  "budget": 0,
  "budget_type": "",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "users": [
    {
      "user_id": 202,
      "hour_rate": 0.0,
      "hour_rate_in_cents": 0.0,
      "updated_at": "2019-11-20T13:33:50+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

Presenting adequate information on various aspects of the business, performance of you and your team. You can export it in excel, pdf and csv format.

All Report

Normal user accessing report for account.

Note:

1) If 'start_date' and 'end_date' parameters are not passed, default period is beginning of month to end of month.

2) if the 'users' and 'projects' parameters are not passed, default normal user will get all the report from account and limited user will get his report.

3) Only normal user can get report of other users of same account. Limited user will always get his report.

4) Only normal user can get report of other projects of same account. Limited user can only get report of his own project.

Request

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

Endpoint

POST /1.1/:account_id/reports

POST /1.1/125/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer drg1DGTFzcWGEUS_GLgyJ6zxO2TQzoF6hf7XaJCEj60

Parameters

{"user_ids":"266","since":"2018-01-01","until":"2019-01-01","project_ids":"129"}
Name Description
account_id Account id for which report to be retrieved
user_ids Specifies the users to get report, should be comma separated numerical user ids Example: "user_ids": "175551,117861"
since Specifies the start date for report Example: "since" : "Jan 01, 2014"
until Specifies the end date for report Example: "until" : "Dec 31, 2014"
project_ids Specifies the projects to get report, should be comma separated numerical project ids Example: "project_ids": "1751,1171"
billed Specifies the report type to retrive estimated or billed events. Example: "billed": false or "billed": true
label_ids Specifies the labels to get report, should be comma separated numerical label ids Example: "label_ids": "751,117"

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 102,
    "name": "Timely",
    "duration": {
      "hours": 5,
      "minutes": 0,
      "seconds": 0,
      "formatted": "05:00",
      "total_hours": 5.0,
      "total_seconds": 18000,
      "total_minutes": 300
    },
    "estimated_duration": {
      "hours": 8,
      "minutes": 0,
      "seconds": 0,
      "formatted": "08:00",
      "total_hours": 8.0,
      "total_seconds": 28800,
      "total_minutes": 480
    },
    "cost": {
      "fractional": 25000,
      "formatted": "$250.00",
      "amount": 250.0
    },
    "estimated_cost": {
      "fractional": 40000,
      "formatted": "$400.00",
      "amount": 400.0
    },
    "projects": [
      {
        "id": 129,
        "active": true,
        "account_id": 125,
        "name": "Timely",
        "color": "67a3bc",
        "rate_type": "project",
        "billable": true,
        "updated_at": 1574253252,
        "external_id": null,
        "budget_scope": null,
        "client": {
          "id": 102,
          "name": "Timely",
          "active": true,
          "external_id": null,
          "updated_at": "2019-11-20T13:34:12+01:00"
        },
        "required_notes": false,
        "budget": 0,
        "budget_type": "",
        "hour_rate": 50.0,
        "hour_rate_in_cents": 5000.0,
        "duration": {
          "hours": 5,
          "minutes": 0,
          "seconds": 0,
          "formatted": "05:00",
          "total_hours": 5.0,
          "total_seconds": 18000,
          "total_minutes": 300
        },
        "estimated_duration": {
          "hours": 8,
          "minutes": 0,
          "seconds": 0,
          "formatted": "08:00",
          "total_hours": 8.0,
          "total_seconds": 28800,
          "total_minutes": 480
        },
        "cost": {
          "fractional": 25000,
          "formatted": "$250.00",
          "amount": 250.0
        },
        "estimated_cost": {
          "fractional": 40000,
          "formatted": "$400.00",
          "amount": 400.0
        }
      }
    ]
  }
]

Filter Report

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

Request

curl "https://api.timelyapp.com1.1/126/reports/filter" -d '{"user_ids":"268","since":"2018-01-01","until":"2019-01-01","project_ids":"130"}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YKVzKiNI2FvAJO2B5_m-RJf9tb6T5-GQxBh6Xj5JSUw" \
    -H "Cookie: "

Endpoint

POST 1.1/:account_id/reports/filter

POST 1.1/126/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer YKVzKiNI2FvAJO2B5_m-RJf9tb6T5-GQxBh6Xj5JSUw

Parameters

{"user_ids":"268","since":"2018-01-01","until":"2019-01-01","project_ids":"130"}
Name Description
billed Retrieve only billed hours. Example: billed=true
label_ids Specifies the label ids to retrieve hours, should be array of numerical label ids Example: label_ids: [3, 4, 2]
project_ids Specifies the project ids to retrieve hours, should be array of numerical project ids Example:project_ids: [3, 4, 2]
since start date for report Example: 'since=2019-01-01'
team_ids Specifies the team ids to retrieve hours, should be array of numerical team ids Example: team_ids: [3, 4, 2]
until start date for report Example: 'since=2019-12-31'
user_ids Specifies the user ids to retrieve hours, should be array of numerical user ids Example: user_ids: [3, 4, 2]

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "clients": [
    {
      "id": 103,
      "name": "Timely",
      "duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "estimated_duration": {
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "formatted": "08:00",
        "total_hours": 8.0,
        "total_seconds": 28800,
        "total_minutes": 480
      },
      "cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      },
      "estimated_cost": {
        "fractional": 40000,
        "formatted": "$400.00",
        "amount": 400.0
      },
      "projects": [
        {
          "id": 130,
          "active": true,
          "account_id": 126,
          "name": "Timely",
          "color": "67a3bc",
          "rate_type": "project",
          "billable": true,
          "updated_at": 1574253252,
          "external_id": null,
          "budget_scope": null,
          "client": {
            "id": 103,
            "name": "Timely",
            "active": true,
            "external_id": null,
            "updated_at": "2019-11-20T13:34:12+01:00"
          },
          "required_notes": false,
          "budget": 0,
          "budget_type": "",
          "hour_rate": 50.0,
          "hour_rate_in_cents": 5000.0,
          "duration": {
            "hours": 5,
            "minutes": 0,
            "seconds": 0,
            "formatted": "05:00",
            "total_hours": 5.0,
            "total_seconds": 18000,
            "total_minutes": 300
          },
          "estimated_duration": {
            "hours": 8,
            "minutes": 0,
            "seconds": 0,
            "formatted": "08:00",
            "total_hours": 8.0,
            "total_seconds": 28800,
            "total_minutes": 480
          },
          "cost": {
            "fractional": 25000,
            "formatted": "$250.00",
            "amount": 250.0
          },
          "estimated_cost": {
            "fractional": 40000,
            "formatted": "$400.00",
            "amount": 400.0
          }
        }
      ]
    }
  ],
  "users": [
    {
      "id": 268,
      "email": "marijacqtwtrzy@timelyapp.com",
      "name": "Marija Petrovic",
      "time_zone": "Europe/Paris",
      "updated_at": 1574253252,
      "active": false,
      "deleted": false,
      "memory_onboarded": true,
      "day_view_onboarded": true,
      "last_received_memories_date": null,
      "default_hour_rate": 0.0,
      "date_format": "dmy",
      "time_format": "24",
      "avatar": {
        "large_retina": "https://www.gravatar.com/avatar/981ccbd9a8c50f383e4e132611f3f3ce?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/981ccbd9a8c50f383e4e132611f3f3ce?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/981ccbd9a8c50f383e4e132611f3f3ce?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/981ccbd9a8c50f383e4e132611f3f3ce?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/981ccbd9a8c50f383e4e132611f3f3ce?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s="
      },
      "duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "estimated_duration": {
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "formatted": "08:00",
        "total_hours": 8.0,
        "total_seconds": 28800,
        "total_minutes": 480
      },
      "cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      },
      "estimated_cost": {
        "fractional": 40000,
        "formatted": "$400.00",
        "amount": 400.0
      }
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "Untagged",
      "sequence": -1,
      "parent_id": null,
      "emoji": "https://raw.githubusercontent.com/iamcal/emoji-data/v2.4.4/img-twitter-64/1f3f7.png",
      "children": [

      ],
      "duration": {
        "hours": 5,
        "minutes": 0,
        "seconds": 0,
        "formatted": "05:00",
        "total_hours": 5.0,
        "total_seconds": 18000,
        "total_minutes": 300
      },
      "estimated_duration": {
        "hours": 8,
        "minutes": 0,
        "seconds": 0,
        "formatted": "08:00",
        "total_hours": 8.0,
        "total_seconds": 28800,
        "total_minutes": 480
      },
      "cost": {
        "fractional": 25000,
        "formatted": "$250.00",
        "amount": 250.0
      },
      "estimated_cost": {
        "fractional": 40000,
        "formatted": "$400.00",
        "amount": 400.0
      }
    }
  ],
  "days": [
    {
      "day": "2018-01-02",
      "duration": {
        "hours": 2,
        "minutes": 30,
        "seconds": 0,
        "formatted": "02:30",
        "total_hours": 2.5,
        "total_seconds": 9000,
        "total_minutes": 150
      },
      "estimated_duration": {
        "hours": 4,
        "minutes": 0,
        "seconds": 0,
        "formatted": "04:00",
        "total_hours": 4.0,
        "total_seconds": 14400,
        "total_minutes": 240
      },
      "cost": {
        "fractional": 12500,
        "formatted": "$125.00",
        "amount": 125.0
      },
      "estimated_cost": {
        "fractional": 20000,
        "formatted": "$200.00",
        "amount": 200.0
      }
    },
    {
      "day": "2018-01-01",
      "duration": {
        "hours": 2,
        "minutes": 30,
        "seconds": 0,
        "formatted": "02:30",
        "total_hours": 2.5,
        "total_seconds": 9000,
        "total_minutes": 150
      },
      "estimated_duration": {
        "hours": 4,
        "minutes": 0,
        "seconds": 0,
        "formatted": "04:00",
        "total_hours": 4.0,
        "total_seconds": 14400,
        "total_minutes": 240
      },
      "cost": {
        "fractional": 12500,
        "formatted": "$125.00",
        "amount": 125.0
      },
      "estimated_cost": {
        "fractional": 20000,
        "formatted": "$200.00",
        "amount": 200.0
      }
    }
  ]
}

Teams

Team object should show all teams available for the given account.

Create a team

Request

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

Endpoint

POST /1.1/:account_id/teams

POST /1.1/144/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer 0QhY6kSvlFDVZWWfn9mufr7k8N9dkHEmt3urnevxap4

Parameters

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

Response

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

Delete a team

Request

curl "https://api.timelyapp.com/1.1/145/teams/2" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 1u_gFecu267DDmifwjR-Oo8rC5HJw8kTPsy7lc-RCUo" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/teams/:id

DELETE /1.1/145/teams/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1u_gFecu267DDmifwjR-Oo8rC5HJw8kTPsy7lc-RCUo

Parameters

Name Description
account_id Account id for which team to be deleted
id The id of the team to be deleted

Response

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

List all teams

Request

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

Endpoint

GET /1.1/:account_id/teams

GET /1.1/147/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer hgXGyBei3ktfGKbTn8dtlvgEL7RPTpTlKoUeuDYHhn4

Parameters

None known.

Response

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

]

Retrieve a team

Request

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

Endpoint

GET /1.1/:account_id/teams/:id

GET /1.1/146/teams/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer pnpKKJyGx4zmCXqwbflQIG4q8Og3CaNM3kAZ3eVH4mQ

Parameters

Name Description
account_id Account id for which team to be retrieved
id The id of the team to be retrieved
page Page number (Default 1)
per_page Records per page (Default 50)
order Sorting order on name

Response

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

Endpoint

PUT /1.1/:account_id/teams/:id

PUT /1.1/148/teams/4
Accept: application/json
Content-Type: application/json
Authorization: Bearer euElSmQasopCCGCc0G7KEP77PHBjlsK6dyKLIP5haH4

Parameters

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

Response

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

Users

Every account can have multiple users associated with it. All users created within one account have limited privileges. A user is usually created by an employer on behalf of the employee.

Create/Invite a user

Note: “user_level” can have values normal/limited. User name and email cannot be updated by anyone, only the user himself can do that.

Request

curl "https://api.timelyapp.com/1.1/153/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":158,"hour_rate":10}]},"admin":{"id":147,"email":"notifications@timelyapp.com","created_at":"2019-11-20T13:34:27.000+01:00","updated_at":"2019-11-20T13:34:27.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 oaoenAbBgLSf-Dps4G3g_rDSR5nhWTD9E3VS_MEMzac" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/users

POST /1.1/153/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer oaoenAbBgLSf-Dps4G3g_rDSR5nhWTD9E3VS_MEMzac

Parameters

{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":158,"hour_rate":10}]},"admin":{"id":147,"email":"notifications@timelyapp.com","created_at":"2019-11-20T13:34:27.000+01:00","updated_at":"2019-11-20T13:34:27.000+01:00","name":"Timely","notifier":false}}
Name Description
user required Label attributes
name required Specifies the user name
email required Specifies the user email
projects Specifies the projects that user will be part of Example"projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }]
user_level Specifies the user level, should be normal/limited, default will be "normal" Example: "user_level": "normal"
admin Specifies the user is admin, in this case user_level should be normal Example: "admin": "true"
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 325,
  "email": "marija@timely.com",
  "name": "Marija Petrovic",
  "active": true,
  "day_view_onboarded": false,
  "memory_onboarded": false,
  "created_at": 1574253267,
  "updated_at": 1574253268,
  "default_hour_rate": 0.0,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Europe/Paris",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/0a8763ca707efea0026580f1712c3fe0?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
  },
  "type": "User",
  "user_level": "normal",
  "admin": false,
  "hide_hourly_rate": false,
  "deleted": false
}

Delete a user

Request

curl "https://api.timelyapp.com/1.1/154/users/326" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer QNlHTIK9rSpq1P-ARhgIQda5SvIVEEM5WLnmtYg8aYs" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/users/:id

DELETE /1.1/154/users/326
Accept: application/json
Content-Type: application/json
Authorization: Bearer QNlHTIK9rSpq1P-ARhgIQda5SvIVEEM5WLnmtYg8aYs

Parameters

Name Description
account_id Account id for which user to be deleted
id The id of the user to be deleted

Response

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

List all users

Note: User list will return recently updated 10 users.

Request

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

Endpoint

GET /1.1/:account_id/users

GET /1.1/157/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer fMPWziGiUtDHbovVxe6r2NomFP767rd4CXGlbmA7ZIg

Parameters

Name Description
account_id Account id for which users to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 332,
    "email": "marijakemmncov@timelyapp.com",
    "name": "Marija Petrovic",
    "active": false,
    "day_view_onboarded": true,
    "memory_onboarded": true,
    "created_at": 1574253272,
    "updated_at": 1574253272,
    "default_hour_rate": 0.0,
    "last_received_memories_date": null,
    "sign_in_count": null,
    "external_id": null,
    "time_zone": "Europe/Paris",
    "avatar": {
      "large_retina": "https://www.gravatar.com/avatar/d44c4d3b393acd370eab7afeb157e192?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/d44c4d3b393acd370eab7afeb157e192?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
      "medium_retina": "https://www.gravatar.com/avatar/d44c4d3b393acd370eab7afeb157e192?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/d44c4d3b393acd370eab7afeb157e192?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "small_retina": "https://www.gravatar.com/avatar/d44c4d3b393acd370eab7afeb157e192?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
      "small": "https://www.gravatar.com/avatar/d44c4d3b393acd370eab7afeb157e192?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
    },
    "type": "User",
    "user_level": "normal",
    "admin": true,
    "hide_hourly_rate": false,
    "deleted": false
  }
]

Retrieve a user

Request

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

Endpoint

GET /1.1/:account_id/users/:id

GET /1.1/155/users/328
Accept: application/json
Content-Type: application/json
Authorization: Bearer pV3IQPQfooQkrDYUpApFljg8JpXOewaLcWcraXkJ1Gc

Parameters

Name Description
account_id Account id for which user to be retrieved
id The id of the user to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 328,
  "email": "marijaearrdkew@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1574253269,
  "updated_at": 1574253269,
  "default_hour_rate": 0.0,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Europe/Paris",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/b09601a4910c7563fae93f3f8082b054?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/b09601a4910c7563fae93f3f8082b054?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/b09601a4910c7563fae93f3f8082b054?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/b09601a4910c7563fae93f3f8082b054?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/b09601a4910c7563fae93f3f8082b054?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/b09601a4910c7563fae93f3f8082b054?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
  },
  "type": "User",
  "user_level": "normal",
  "admin": true,
  "hide_hourly_rate": false,
  "deleted": false
}

Retrieve current user

Request

curl -g "https://api.timelyapp.com/1.1/156/users/current" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer fK_mc3owHMDnr_k-_yo866OhmH-ZsywAvikqR-b8Hbc" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/current

GET /1.1/156/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer fK_mc3owHMDnr_k-_yo866OhmH-ZsywAvikqR-b8Hbc

Parameters

Name Description
account_id Account id for which current user to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 330,
  "email": "marijaxfxxgrla@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1574253270,
  "updated_at": 1574253270,
  "default_hour_rate": 0.0,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Europe/Paris",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/a4de2e7d11f3605afd7836f8e582b7b3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/a4de2e7d11f3605afd7836f8e582b7b3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/a4de2e7d11f3605afd7836f8e582b7b3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/a4de2e7d11f3605afd7836f8e582b7b3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/a4de2e7d11f3605afd7836f8e582b7b3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/a4de2e7d11f3605afd7836f8e582b7b3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
  },
  "type": "User",
  "user_level": "normal",
  "admin": true,
  "hide_hourly_rate": false,
  "deleted": false
}

Update a user

Note:

All other parameters are as mention in create user.

Should not update “user_level” and “projects” as these fields are only editable by admin for other users.

Only admin user can update other users profile, limited user will only update self profile.

Request

curl "https://api.timelyapp.com/1.1/158/users/334" -d '{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":163,"hour_rate":10}]},"admin":{"id":152,"email":"notifications@timelyapp.com","created_at":"2019-11-20T13:34:34.000+01:00","updated_at":"2019-11-20T13:34:34.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 h9fijVTkTvq0_LJPT4KqLlymoA3KhHsjHdaAfrSzkOE" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/users/:id

PUT /1.1/158/users/334
Accept: application/json
Content-Type: application/json
Authorization: Bearer h9fijVTkTvq0_LJPT4KqLlymoA3KhHsjHdaAfrSzkOE

Parameters

{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":163,"hour_rate":10}]},"admin":{"id":152,"email":"notifications@timelyapp.com","created_at":"2019-11-20T13:34:34.000+01:00","updated_at":"2019-11-20T13:34:34.000+01:00","name":"Timely","notifier":false}}
Name Description
id required The numerical ID of the desired user.
user required Label attributes
name required Specifies the user name
email required Specifies the user email
projects Specifies the projects that user will be part of Example"projects": [ {"project_id": 11 , "hour_rate": 10 }, {"project_id": 12 , "hour_rate": 20 }]
user_level Specifies the user level, should be normal/limited, default will be "normal" Example: "user_level": "normal"
admin Specifies the user is admin, in this case user_level should be normal Example: "admin": "true"
external_id The external_id can be used to reference external resource ids to Timely resources, should be alphanumeric 512 characters

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 334,
  "email": "marijalazacbvo@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1574253273,
  "updated_at": 1574253273,
  "default_hour_rate": 0.0,
  "last_received_memories_date": null,
  "sign_in_count": null,
  "external_id": null,
  "time_zone": "Europe/Paris",
  "avatar": {
    "large_retina": "https://www.gravatar.com/avatar/45bb84e73f89c405c0034d260bd61cbd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/45bb84e73f89c405c0034d260bd61cbd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/45bb84e73f89c405c0034d260bd61cbd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/45bb84e73f89c405c0034d260bd61cbd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/45bb84e73f89c405c0034d260bd61cbd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/45bb84e73f89c405c0034d260bd61cbd?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25"
  },
  "type": "User",
  "user_level": "normal",
  "admin": false,
  "hide_hourly_rate": false,
  "deleted": false
}

Errors

Example responses:

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

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

Accessing unauthorized to another project, account, or trying to create or delete objects that are not under our control will result in errors.

The Timely API uses the following error codes:

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