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 psdobV0d_c7YN1DueDye8_0wJFkSFQtZPPOzkUwTiIc" \
    -H "Cookie: "

Endpoint

GET /1.1/accounts

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

Parameters

None known.

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 106,
    "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": 106,
    "plan_name": "Essential",
    "next_charge": "2019-12-12",
    "start_of_week": 0,
    "created_at": 1573558941,
    "payment_mode": "web",
    "paid": true,
    "company_size": "10-49",
    "plan_code": "essential",
    "appstore_transaction_id": null,
    "owner_id": 216,
    "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/105" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer pZztLGbTDS_Ygu_Jdq2Oz2IAig6tN6jYhkwCawjT8PM" \
    -H "Cookie: "

Endpoint

GET /1.1/accounts/:id

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

Parameters

Name Description
id The id of the account to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 105,
  "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": 105,
  "plan_name": "Essential",
  "next_charge": "2019-12-12",
  "start_of_week": 0,
  "created_at": 1573558940,
  "payment_mode": "web",
  "paid": true,
  "company_size": "10-49",
  "plan_code": "essential",
  "appstore_transaction_id": null,
  "owner_id": 214,
  "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/104/activities" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer zhV5u0xtvLe9cgXhjcGq3ZkRxskEFIF1UtErq4t3N3I" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/activities

GET /1.1/104/activities
Accept: application/json
Content-Type: application/json
Authorization: Bearer zhV5u0xtvLe9cgXhjcGq3ZkRxskEFIF1UtErq4t3N3I

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/128/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 MGNbE-xE_v-L-mklwL5wgMJu2rmYUIA3AZEjxBSL_e8" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/clients

POST /1.1/128/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer MGNbE-xE_v-L-mklwL5wgMJu2rmYUIA3AZEjxBSL_e8

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": 99,
  "name": "Timely",
  "active": true,
  "external_id": null,
  "updated_at": "2019-11-12T12:42:35+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/129/clients" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer gZfhd9aRudRJEsPJVZN0AMumwCvmG5j80-pGRFpj6Xg" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/clients

GET /1.1/129/clients
Accept: application/json
Content-Type: application/json
Authorization: Bearer gZfhd9aRudRJEsPJVZN0AMumwCvmG5j80-pGRFpj6Xg

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": 100,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-12T12:42:35+01:00"
  }
]

Update a client

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

Request

curl "https://api.timelyapp.com/1.1/130/clients/101" -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 YRL4JRVMQO_Jo89vtvfzBXkj_VbRvL4lXC1LmcZEshE" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/clients/:id

PUT /1.1/130/clients/101
Accept: application/json
Content-Type: application/json
Authorization: Bearer YRL4JRVMQO_Jo89vtvfzBXkj_VbRvL4lXC1LmcZEshE

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": 101,
  "name": "Updated name",
  "active": true,
  "external_id": null,
  "updated_at": "2019-11-12T12:42:36+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/147/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-12T12:42:45.944+01:00","to":"2019-11-12T16:12:45.944+01:00","day":"2019-11-12","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":106}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer AbO32jlpaY8NntgKyXHzeIm9L7xBWcWLOyf-6pQ_NzI" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/events

POST /1.1/147/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer AbO32jlpaY8NntgKyXHzeIm9L7xBWcWLOyf-6pQ_NzI

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-12T12:42:45.944+01:00","to":"2019-11-12T16:12:45.944+01:00","day":"2019-11-12","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":106}}
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": 80,
  "uid": "f033ab37c30201f73f142449d037028d",
  "user": {
    "id": 303,
    "email": "marijaeytrphua@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/239977e2324d94fe2986e192b65e794b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/239977e2324d94fe2986e192b65e794b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/239977e2324d94fe2986e192b65e794b?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:43+01:00"
  },
  "project": {
    "id": 106,
    "active": true,
    "account_id": 147,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558965,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 107,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:42:45+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-12",
  "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": 1573558967,
  "created_at": 1573558967,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:12:45+01:00",
  "from": "2019-11-12T12:42:45+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 303,
  "updater_id": 303,
  "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/146/projects/105/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-12T12:42:42.322+01:00","to":"2019-11-12T16:12:42.322+01:00","day":"2019-11-12","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":105}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer rt2GldVvGnuoRJHTj-7JZeyxnPio50D1RH0hQko-KL8" \
    -H "Cookie: "

Endpoint

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

POST /1.1/146/projects/105/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer rt2GldVvGnuoRJHTj-7JZeyxnPio50D1RH0hQko-KL8

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-12T12:42:42.322+01:00","to":"2019-11-12T16:12:42.322+01:00","day":"2019-11-12","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":105}}
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": 79,
  "uid": "d1fe173d08e959397adf34b1d77e88d7",
  "user": {
    "id": 301,
    "email": "marijaahuihuyg@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/1846cc6c64ca9d0101eaf90bb27d7140?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/1846cc6c64ca9d0101eaf90bb27d7140?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/1846cc6c64ca9d0101eaf90bb27d7140?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:40+01:00"
  },
  "project": {
    "id": 105,
    "active": true,
    "account_id": 146,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558962,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 106,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:42:42+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-12",
  "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": 1573558962,
  "created_at": 1573558962,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:12:42+01:00",
  "from": "2019-11-12T12:42:42+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 301,
  "updater_id": 301,
  "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/145/users/299/events" -d '{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-12T12:42:40.107+01:00","to":"2019-11-12T16:12:40.107+01:00","day":"2019-11-12","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":299}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 1Fbw1k4N8sVVrUpP1mqd4E5jhow_I1FOBTRMPtwsx9o" \
    -H "Cookie: "

Endpoint

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

POST /1.1/145/users/299/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 1Fbw1k4N8sVVrUpP1mqd4E5jhow_I1FOBTRMPtwsx9o

Parameters

{"event":{"hours":3,"minutes":30,"seconds":0,"estimated_hours":4,"estimated_minutes":0,"from":"2019-11-12T12:42:40.107+01:00","to":"2019-11-12T16:12:40.107+01:00","day":"2019-11-12","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":299}}
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": 78,
  "uid": "35f4a8d465e6e1edc05f3d8ab658c551",
  "user": {
    "id": 299,
    "email": "marijagxjetnbf@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/928e791c55f4ceef7bd2e93e665b5464?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/928e791c55f4ceef7bd2e93e665b5464?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/928e791c55f4ceef7bd2e93e665b5464?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:39+01:00"
  },
  "project": {
    "id": 104,
    "active": true,
    "account_id": 145,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558960,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 105,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:42:40+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-12",
  "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": 1573558960,
  "created_at": 1573558960,
  "created_from": "Timely",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:12:40+01:00",
  "from": "2019-11-12T12:42:40+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": 299,
  "updater_id": 299,
  "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/148/events/81" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 8FXuWROeumtS5BKBAx1zzyESdM7zkaEnCvYBAyvD8ek" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/events/:id

DELETE /1.1/148/events/81
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8FXuWROeumtS5BKBAx1zzyESdM7zkaEnCvYBAyvD8ek

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/150/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 7GnYScM3OFB0CA2gPIPV_jenKfftYQ6naMPs1v18f4k" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/events

GET /1.1/150/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 7GnYScM3OFB0CA2gPIPV_jenKfftYQ6naMPs1v18f4k

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": 83,
    "uid": "fe9fc289c3ff0af142b6d3bead98a923",
    "user": {
      "id": 309,
      "email": "marijavcpnmulk@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "timeline": "https://www.gravatar.com/avatar/f6808ee38ae3184ed1fe3850686b6661?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/f6808ee38ae3184ed1fe3850686b6661?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/f6808ee38ae3184ed1fe3850686b6661?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
      },
      "updated_at": "2019-11-12T12:42:51+01:00"
    },
    "project": {
      "id": 109,
      "active": true,
      "account_id": 150,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1573558973,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 110,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2019-11-12T12:42:53+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-12",
    "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": 1573558973,
    "created_at": 1573558973,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2019-11-12T16:12:53+01:00",
    "from": "2019-11-12T12:42:53+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/152/projects/111/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer GyywBzVtjt8pWeYilkKYcMN7kYAWRPx3imKK8w8TjB8" \
    -H "Cookie: "

Endpoint

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

GET /1.1/152/projects/111/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer GyywBzVtjt8pWeYilkKYcMN7kYAWRPx3imKK8w8TjB8

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": 85,
    "uid": "3ef815416f775098fe977004015c6193",
    "user": {
      "id": 313,
      "email": "marijaxqquehln@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "timeline": "https://www.gravatar.com/avatar/5790c3fc1d20901f561b458e5ea841de?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/5790c3fc1d20901f561b458e5ea841de?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/5790c3fc1d20901f561b458e5ea841de?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
      },
      "updated_at": "2019-11-12T12:42:55+01:00"
    },
    "project": {
      "id": 111,
      "active": true,
      "account_id": 152,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1573558975,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 112,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2019-11-12T12:42:55+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-12",
    "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": 1573558975,
    "created_at": 1573558975,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2019-11-12T16:12:55+01:00",
    "from": "2019-11-12T12:42:55+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/151/users/311/events" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 8nBSka1rtPc98rpjMFh-wvmuCC4s9WVUCcEqmf5xxZo" \
    -H "Cookie: "

Endpoint

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

GET /1.1/151/users/311/events
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8nBSka1rtPc98rpjMFh-wvmuCC4s9WVUCcEqmf5xxZo

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": 84,
    "uid": "68d30a9594728bc39aa24be94b319d21",
    "user": {
      "id": 311,
      "email": "marijapofrjmcn@timelyapp.com",
      "name": "Marija Petrovic",
      "avatar": {
        "timeline": "https://www.gravatar.com/avatar/8c1013c9ac81c115c4fea5aae96feddb?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/8c1013c9ac81c115c4fea5aae96feddb?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/8c1013c9ac81c115c4fea5aae96feddb?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
      },
      "updated_at": "2019-11-12T12:42:54+01:00"
    },
    "project": {
      "id": 110,
      "active": true,
      "account_id": 151,
      "name": "Timely",
      "color": "67a3bc",
      "rate_type": "project",
      "billable": true,
      "updated_at": 1573558974,
      "external_id": null,
      "budget_scope": null,
      "client": {
        "id": 111,
        "name": "Timely",
        "active": true,
        "external_id": null,
        "updated_at": "2019-11-12T12:42:54+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-12",
    "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": 1573558974,
    "created_at": 1573558974,
    "created_from": "Web",
    "updated_from": "Web",
    "billed": false,
    "to": "2019-11-12T16:12:54+01:00",
    "from": "2019-11-12T12:42:54+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/157/users/323/events/90" -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 eS7X7TaKMYIO2KhE_G15hgl4EGU7KZi7vrEQYLklC1U" \
    -H "Cookie: "

Endpoint

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

PUT /1.1/157/users/323/events/90
Accept: application/json
Content-Type: application/json
Authorization: Bearer eS7X7TaKMYIO2KhE_G15hgl4EGU7KZi7vrEQYLklC1U

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": 90,
  "uid": "8613985ec49eb8f757ae6439e879bb2a",
  "user": {
    "id": 323,
    "email": "marijasqnzywgp@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/7edd70a5456cde0aad590ec321ac02f3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/7edd70a5456cde0aad590ec321ac02f3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/7edd70a5456cde0aad590ec321ac02f3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:43:00+01:00"
  },
  "project": {
    "id": 116,
    "active": true,
    "account_id": 157,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558981,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 117,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:43:01+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-12",
  "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": 1573558981,
  "created_at": 1573558981,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:13:01+01:00",
  "from": "2019-11-12T12:43:01+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 323,
  "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/156/projects/115/events/89" -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 u1zkztTxR6AkY25BLxtQQOOopdyr6jmHF6cXDO79psA" \
    -H "Cookie: "

Endpoint

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

PUT /1.1/156/projects/115/events/89
Accept: application/json
Content-Type: application/json
Authorization: Bearer u1zkztTxR6AkY25BLxtQQOOopdyr6jmHF6cXDO79psA

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": 89,
  "uid": "7647966b7343c29048673252e490f736",
  "user": {
    "id": 321,
    "email": "marijagxnzccua@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/2729f8e0ea5242e400ca821005faac6d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/2729f8e0ea5242e400ca821005faac6d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/2729f8e0ea5242e400ca821005faac6d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:59+01:00"
  },
  "project": {
    "id": 115,
    "active": true,
    "account_id": 156,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558980,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 116,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:43:00+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-12",
  "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": 1573558980,
  "created_at": 1573558980,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:13:00+01:00",
  "from": "2019-11-12T12:43:00+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 321,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Retrieve an event

Request

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

Endpoint

GET /1.1/:account_id/events/:id

GET /1.1/149/events/82
Accept: application/json
Content-Type: application/json
Authorization: Bearer uev6oj9av-e7zqULs9HHaBP7zUNVDQuGWmZp1qzIylw

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": 82,
  "uid": "9778d5d219c5080b9a6a17bef029331c",
  "user": {
    "id": 307,
    "email": "marijaitweeigo@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/fc86d44105842826d017d3c3b1c494e3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/fc86d44105842826d017d3c3b1c494e3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/fc86d44105842826d017d3c3b1c494e3?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:49+01:00"
  },
  "project": {
    "id": 108,
    "active": true,
    "account_id": 149,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558970,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 109,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:42:50+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-12",
  "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": 1573558970,
  "created_at": 1573558970,
  "created_from": "Web",
  "updated_from": "Web",
  "billed": false,
  "to": "2019-11-12T16:12:50+01:00",
  "from": "2019-11-12T12:42:50+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/153/events/86/start" -d '' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer rfiTes1nlQfgTbCg5q1lh27JkkftBMYB4mcS-3uWEFw" \
    -H "Cookie: "

Endpoint

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

PUT /1.1/153/events/86/start
Accept: application/json
Content-Type: application/json
Authorization: Bearer rfiTes1nlQfgTbCg5q1lh27JkkftBMYB4mcS-3uWEFw

Parameters

Name Description
id required Event id

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 86,
  "uid": "93db85ed909c13838ff95ccfa94cebd9",
  "user": {
    "id": 315,
    "email": "marijayjzrhesj@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/37340d59c967fdad5715f0b4160b4f3d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/37340d59c967fdad5715f0b4160b4f3d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/37340d59c967fdad5715f0b4160b4f3d?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:55+01:00"
  },
  "project": {
    "id": 112,
    "active": true,
    "account_id": 153,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558977,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 113,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:42:57+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-12",
  "note": "Notes for testing with some random #hash in it.",
  "sequence": 1,
  "estimated": false,
  "timer_state": "start",
  "timer_started_on": 1573558977,
  "timer_stopped_on": 0,
  "label_ids": [

  ],
  "user_ids": [

  ],
  "updated_at": 1573558977,
  "created_at": 1573558977,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:12:57+01:00",
  "from": "2019-11-12T12:42:57+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 315,
  "external_id": null,
  "entry_ids": [

  ],
  "suggestion_id": null
}

Stop timer on event

Request

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

Endpoint

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

PUT /1.1/154/events/87/stop
Accept: application/json
Content-Type: application/json
Authorization: Bearer 72h1MC2hvzBbh0cXRdPIOPOgFt8udtYhHKjBIg5kKCE

Parameters

Name Description
id required Event id

Response

Content-Type: application/json; charset=utf-8
200 OK
{
  "id": 87,
  "uid": "c7e1249ffc03eb9ded908c236bd1996d",
  "user": {
    "id": 317,
    "email": "marijabiuuwtze@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/dbf19c7ad0dc404811af5fe4b032d8af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/dbf19c7ad0dc404811af5fe4b032d8af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/dbf19c7ad0dc404811af5fe4b032d8af?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:57+01:00"
  },
  "project": {
    "id": 113,
    "active": true,
    "account_id": 154,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558978,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 114,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:42:58+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-12",
  "note": "Notes for testing with some random #hash in it.",
  "sequence": 1,
  "estimated": false,
  "timer_state": "stop",
  "timer_started_on": 0,
  "timer_stopped_on": 1573558978,
  "label_ids": [

  ],
  "user_ids": [

  ],
  "updated_at": 1573558978,
  "created_at": 1573558978,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:12:58+01:00",
  "from": "2019-11-12T12:42:58+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 317,
  "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/155/events/88" -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 e4VHGGhoIx_9HUsDQpgGYDXgDnfOCZeaeJ4QiU5e9F8" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/events/:id

PUT /1.1/155/events/88
Accept: application/json
Content-Type: application/json
Authorization: Bearer e4VHGGhoIx_9HUsDQpgGYDXgDnfOCZeaeJ4QiU5e9F8

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": 88,
  "uid": "2a38a4a9316c49e5a833517c45d31070",
  "user": {
    "id": 319,
    "email": "marijailovyoip@timelyapp.com",
    "name": "Marija Petrovic",
    "avatar": {
      "timeline": "https://www.gravatar.com/avatar/9fbaf71f5882d99a7838d1dcd136af8a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_timeline-41a3c6144fa6b06eceedb1fa1d82ed1763f24f9b93904044558c64c0e868fbec.jpg&s=",
      "medium_retina": "https://www.gravatar.com/avatar/9fbaf71f5882d99a7838d1dcd136af8a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/9fbaf71f5882d99a7838d1dcd136af8a?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s="
    },
    "updated_at": "2019-11-12T12:42:58+01:00"
  },
  "project": {
    "id": 114,
    "active": true,
    "account_id": 155,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558979,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 115,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:42:59+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-12",
  "note": "Updated notes",
  "sequence": 1,
  "estimated": true,
  "timer_state": "default",
  "timer_started_on": 0,
  "timer_stopped_on": 0,
  "label_ids": [

  ],
  "user_ids": [

  ],
  "updated_at": 1573558979,
  "created_at": 1573558979,
  "created_from": "Web",
  "updated_from": "Timely",
  "billed": false,
  "to": "2019-11-12T16:12:59+01:00",
  "from": "2019-11-12T12:42:59+01:00",
  "deleted": false,
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "creator_id": null,
  "updater_id": 319,
  "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/160/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 Z2KDrPi74AUM3Yzz7fGZCtUkbpk2KtOTy2ojEEHZfMw" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/labels

POST /1.1/160/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer Z2KDrPi74AUM3Yzz7fGZCtUkbpk2KtOTy2ojEEHZfMw

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": 1,
  "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/161/labels/2" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer SrwgflDGk4XBfYD5-0MbpnhXi0gAY4ZOTF_BkoGdEgk" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/labels/:id

DELETE /1.1/161/labels/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer SrwgflDGk4XBfYD5-0MbpnhXi0gAY4ZOTF_BkoGdEgk

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/164/labels?parent_id=4" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer TcKFQPwswmu5lZKBPVR4W2sVA8O6PxNiLbU09Jgb1uw" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/labels

GET /1.1/164/labels?parent_id=4
Accept: application/json
Content-Type: application/json
Authorization: Bearer TcKFQPwswmu5lZKBPVR4W2sVA8O6PxNiLbU09Jgb1uw

Parameters

parent_id: 4
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": 4,
  "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/163/labels" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer QYXCltIyJXH3XpcWVhbJTxb9DqU3ZAajIP-Odf-hCig" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/labels

GET /1.1/163/labels
Accept: application/json
Content-Type: application/json
Authorization: Bearer QYXCltIyJXH3XpcWVhbJTxb9DqU3ZAajIP-Odf-hCig

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/162/labels/3" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer sAKQavcSKCH7aTTFnTBc-n2hOZEMHS-oLOZHeam6svY" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/labels/:id

GET /1.1/162/labels/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer sAKQavcSKCH7aTTFnTBc-n2hOZEMHS-oLOZHeam6svY

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": 3,
  "name": "Web Programming",
  "sequence": 1,
  "parent_id": null,
  "emoji": null,
  "children": [

  ]
}

Update a label

Request

curl "https://api.timelyapp.com/1.1/165/labels/5" -d '{"label":{"name":"updated name"}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Vf5N7MN2azLgJa3XzC-Y-1-dq-Xnzd9GE_bxanO5s54" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/labels/:id

PUT /1.1/165/labels/5
Accept: application/json
Content-Type: application/json
Authorization: Bearer Vf5N7MN2azLgJa3XzC-Y-1-dq-Xnzd9GE_bxanO5s54

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": 5,
  "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/181/projects" -d '{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":137,"budget_type":"M","budget":300,"users":[{"user_id":368}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":6,"required":true},{"label_id":7,"required":true},{"label_id":8,"required":false},{"label_id":9,"required":false}]}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer CjjuQ_wSEFSIn4ql3Hgz8smj_yziXJN-LhDZqeBo3y4" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/projects

POST /1.1/181/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer CjjuQ_wSEFSIn4ql3Hgz8smj_yziXJN-LhDZqeBo3y4

Parameters

{"project":{"name":"New Project","rate_type":"project","hour_rate":50.0,"active":true,"deleted":false,"currency_code":"usd","color":"67a3bc","client_id":137,"budget_type":"M","budget":300,"users":[{"user_id":368}],"budget_recurrence":{"recur":"week","start_date":"2018-09-21","end_date":"2019-09-21","recur_until":"end_date"},"labels":[{"label_id":6,"required":true},{"label_id":7,"required":true},{"label_id":8,"required":false},{"label_id":9,"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": 137,
  "active": true,
  "account_id": 181,
  "name": "New Project",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1573558989,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 137,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-12T12:43:09+01:00"
  },
  "required_notes": false,
  "budget": 300,
  "budget_type": "M",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "users": [
    {
      "user_id": 368,
      "hour_rate": 50.0,
      "hour_rate_in_cents": 5000.0,
      "updated_at": "2019-11-12T12:43:09+01:00",
      "deleted": false
    }
  ],
  "labels": [
    {
      "project_id": 137,
      "label_id": 6,
      "budget": null,
      "required": true,
      "updated_at": "2019-11-12T12:43:09+01:00"
    },
    {
      "project_id": 137,
      "label_id": 7,
      "budget": null,
      "required": true,
      "updated_at": "2019-11-12T12:43:09+01:00"
    },
    {
      "project_id": 137,
      "label_id": 8,
      "budget": null,
      "required": false,
      "updated_at": "2019-11-12T12:43:09+01:00"
    },
    {
      "project_id": 137,
      "label_id": 9,
      "budget": null,
      "required": false,
      "updated_at": "2019-11-12T12:43:09+01:00"
    }
  ],
  "label_ids": [
    6,
    7,
    8,
    9
  ],
  "required_label_ids": [
    6,
    7
  ],
  "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-12T12:43:09+01:00"
  }
}

Delete a project

Request

curl "https://api.timelyapp.com/1.1/182/projects/138" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer G2yYnpnor8-ra7-tj2zFfpZ7MLs1YdsMrh8E3W9z8Lw" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/projects/:id

DELETE /1.1/182/projects/138
Accept: application/json
Content-Type: application/json
Authorization: Bearer G2yYnpnor8-ra7-tj2zFfpZ7MLs1YdsMrh8E3W9z8Lw

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/184/projects" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer fuDCoUiho_0yqlitmA9KdUUl2fmHC66Y1ntNWzFSzDo" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/projects

GET /1.1/184/projects
Accept: application/json
Content-Type: application/json
Authorization: Bearer fuDCoUiho_0yqlitmA9KdUUl2fmHC66Y1ntNWzFSzDo

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": 140,
    "active": true,
    "account_id": 184,
    "name": "Timely",
    "color": "67a3bc",
    "rate_type": "project",
    "billable": true,
    "updated_at": 1573558991,
    "external_id": null,
    "budget_scope": null,
    "client": {
      "id": 140,
      "name": "Timely",
      "active": true,
      "external_id": null,
      "updated_at": "2019-11-12T12:43:11+01:00"
    },
    "required_notes": false,
    "budget": 0,
    "budget_type": "",
    "hour_rate": 50.0,
    "hour_rate_in_cents": 5000.0,
    "users": [
      {
        "user_id": 374,
        "hour_rate": 100.0,
        "hour_rate_in_cents": 10000.0,
        "updated_at": "2019-11-12T12:43:11+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/183/projects/139" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer nEJ4fsAn1znV2h_tMell-rP8NDi1ilxq3XIiwh9hKN4" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/projects/:id

GET /1.1/183/projects/139
Accept: application/json
Content-Type: application/json
Authorization: Bearer nEJ4fsAn1znV2h_tMell-rP8NDi1ilxq3XIiwh9hKN4

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": 139,
  "active": true,
  "account_id": 183,
  "name": "Timely",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1573558990,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 139,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-12T12:43:10+01:00"
  },
  "required_notes": false,
  "budget": 0,
  "budget_type": "",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "users": [
    {
      "user_id": 372,
      "hour_rate": 100.0,
      "hour_rate_in_cents": 10000.0,
      "updated_at": "2019-11-12T12:43:10+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/186/projects/142" -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 uYBNI0ql-aWOnWPFXm_vwa5XGdr4YQ1TznvMXGzu9lc" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/projects/:id

PUT /1.1/186/projects/142
Accept: application/json
Content-Type: application/json
Authorization: Bearer uYBNI0ql-aWOnWPFXm_vwa5XGdr4YQ1TznvMXGzu9lc

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": 142,
  "active": true,
  "account_id": 186,
  "name": "updated project name",
  "color": "67a3bc",
  "rate_type": "project",
  "billable": true,
  "updated_at": 1573558991,
  "external_id": null,
  "budget_scope": null,
  "client": {
    "id": 142,
    "name": "Timely",
    "active": true,
    "external_id": null,
    "updated_at": "2019-11-12T12:43:11+01:00"
  },
  "required_notes": false,
  "budget": 0,
  "budget_type": "",
  "hour_rate": 50.0,
  "hour_rate_in_cents": 5000.0,
  "users": [
    {
      "user_id": 378,
      "hour_rate": 0.0,
      "hour_rate_in_cents": 0.0,
      "updated_at": "2019-11-12T12:43:12+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/216/reports" -d '{"user_ids":"442","since":"2018-01-01","until":"2019-01-01","project_ids":"199"}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ytVOL6GeVECU7y80xVRHpMXBauCs1KzJwyHpgxnQM2Q" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/reports

POST /1.1/216/reports
Accept: application/json
Content-Type: application/json
Authorization: Bearer ytVOL6GeVECU7y80xVRHpMXBauCs1KzJwyHpgxnQM2Q

Parameters

{"user_ids":"442","since":"2018-01-01","until":"2019-01-01","project_ids":"199"}
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": 172,
    "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": 199,
        "active": true,
        "account_id": 216,
        "name": "Timely",
        "color": "67a3bc",
        "rate_type": "project",
        "billable": true,
        "updated_at": 1573559010,
        "external_id": null,
        "budget_scope": null,
        "client": {
          "id": 172,
          "name": "Timely",
          "active": true,
          "external_id": null,
          "updated_at": "2019-11-12T12:43:30+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/217/reports/filter" -d '{"user_ids":"444","since":"2018-01-01","until":"2019-01-01","project_ids":"200"}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer KveUPTtrhK7t5GWwCPujvkeb2EkH9XnceEXY8W28gtg" \
    -H "Cookie: "

Endpoint

POST 1.1/:account_id/reports/filter

POST 1.1/217/reports/filter
Accept: application/json
Content-Type: application/json
Authorization: Bearer KveUPTtrhK7t5GWwCPujvkeb2EkH9XnceEXY8W28gtg

Parameters

{"user_ids":"444","since":"2018-01-01","until":"2019-01-01","project_ids":"200"}
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": 173,
      "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": 200,
          "active": true,
          "account_id": 217,
          "name": "Timely",
          "color": "67a3bc",
          "rate_type": "project",
          "billable": true,
          "updated_at": 1573559010,
          "external_id": null,
          "budget_scope": null,
          "client": {
            "id": 173,
            "name": "Timely",
            "active": true,
            "external_id": null,
            "updated_at": "2019-11-12T12:43:30+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": 444,
      "email": "marijafcxxsrmv@timelyapp.com",
      "name": "Marija Petrovic",
      "time_zone": "Europe/Paris",
      "updated_at": 1573559010,
      "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/6f50537e03efdfea40260143f7f59bae?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
        "large": "https://www.gravatar.com/avatar/6f50537e03efdfea40260143f7f59bae?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=",
        "medium_retina": "https://www.gravatar.com/avatar/6f50537e03efdfea40260143f7f59bae?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
        "medium": "https://www.gravatar.com/avatar/6f50537e03efdfea40260143f7f59bae?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=",
        "timeline": "https://www.gravatar.com/avatar/6f50537e03efdfea40260143f7f59bae?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/235/teams" -d '{"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":480,"lead":true},{"user_id":482,"lead":false}]}}' -X POST \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer HI1x_ES5-Juc0nlI2HR7JJ9EmrqeF8_wCKOxV0KrYiE" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/teams

POST /1.1/235/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer HI1x_ES5-Juc0nlI2HR7JJ9EmrqeF8_wCKOxV0KrYiE

Parameters

{"team":{"name":"Timely","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":480,"lead":true},{"user_id":482,"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": [
    480,
    482
  ],
  "users": [
    {
      "id": 1,
      "user_id": 480,
      "team_id": 1,
      "lead": true
    },
    {
      "id": 2,
      "user_id": 482,
      "team_id": 1,
      "lead": false
    }
  ]
}

Delete a team

Request

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

Endpoint

DELETE /1.1/:account_id/teams/:id

DELETE /1.1/236/teams/2
Accept: application/json
Content-Type: application/json
Authorization: Bearer tgFDS05YaEO5784Lzj3Wk_K0q0P4DlTBCw9DAKMftqs

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/238/teams" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 07ivyQap1MOOQG9APaGEs9OsTIruiZXqj-oIYGmenKk" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/teams

GET /1.1/238/teams
Accept: application/json
Content-Type: application/json
Authorization: Bearer 07ivyQap1MOOQG9APaGEs9OsTIruiZXqj-oIYGmenKk

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/237/teams/3" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer TOX_cNw8fR9neBeFWXkW0d7fxV2r7V2aREAVRTbKqPI" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/teams/:id

GET /1.1/237/teams/3
Accept: application/json
Content-Type: application/json
Authorization: Bearer TOX_cNw8fR9neBeFWXkW0d7fxV2r7V2aREAVRTbKqPI

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/239/teams/4" -d '{"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":489,"lead":true}]}}' -X PUT \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer izdqH7DVI5r1844Ayys20EHEgXyTnP6bnbKvDJWvyjs" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/teams/:id

PUT /1.1/239/teams/4
Accept: application/json
Content-Type: application/json
Authorization: Bearer izdqH7DVI5r1844Ayys20EHEgXyTnP6bnbKvDJWvyjs

Parameters

{"team":{"name":"Backend","color":"67a3bc","emoji":"http://path.to/emoji.png","external_id":null,"users":[{"user_id":489,"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": [
    489
  ],
  "users": [
    {
      "id": 3,
      "user_id": 489,
      "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/244/users" -d '{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":228,"hour_rate":10}]},"admin":{"id":243,"email":"notifications@timelyapp.com","created_at":"2019-11-12T12:43:43.000+01:00","updated_at":"2019-11-12T12:43:43.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 St6rbvw6CsUdjPbTWFI2BcBsrVIY_941wakGOPzUwDw" \
    -H "Cookie: "

Endpoint

POST /1.1/:account_id/users

POST /1.1/244/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer St6rbvw6CsUdjPbTWFI2BcBsrVIY_941wakGOPzUwDw

Parameters

{"user":{"name":"Marija Petrovic","email":"marija@timely.com","user_level":"normal","admin":false,"projects":[{"project_id":228,"hour_rate":10}]},"admin":{"id":243,"email":"notifications@timelyapp.com","created_at":"2019-11-12T12:43:43.000+01:00","updated_at":"2019-11-12T12:43:43.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": 501,
  "email": "marija@timely.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": false,
  "memory_onboarded": false,
  "created_at": 1573559023,
  "updated_at": 1573559023,
  "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/245/users/502" -d '' -X DELETE \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer 8fhBVNg2sDd5siIeBjL4aQhKpTBgLjbUAYKYkqTni5k" \
    -H "Cookie: "

Endpoint

DELETE /1.1/:account_id/users/:id

DELETE /1.1/245/users/502
Accept: application/json
Content-Type: application/json
Authorization: Bearer 8fhBVNg2sDd5siIeBjL4aQhKpTBgLjbUAYKYkqTni5k

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/248/users" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer TdIj2eA81a0BShsodurVU88u8gKcqR0yC-Ogmz_-vsU" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users

GET /1.1/248/users
Accept: application/json
Content-Type: application/json
Authorization: Bearer TdIj2eA81a0BShsodurVU88u8gKcqR0yC-Ogmz_-vsU

Parameters

Name Description
account_id Account id for which users to be retrieved

Response

Content-Type: application/json; charset=utf-8
200 OK
[
  {
    "id": 508,
    "email": "marijarbmsxvxx@timelyapp.com",
    "name": "Marija Petrovic",
    "active": false,
    "day_view_onboarded": true,
    "memory_onboarded": true,
    "created_at": 1573559026,
    "updated_at": 1573559026,
    "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/ac961ac352f787d0f6f55cb8aec38474?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
      "large": "https://www.gravatar.com/avatar/ac961ac352f787d0f6f55cb8aec38474?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
      "medium_retina": "https://www.gravatar.com/avatar/ac961ac352f787d0f6f55cb8aec38474?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "medium": "https://www.gravatar.com/avatar/ac961ac352f787d0f6f55cb8aec38474?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
      "small_retina": "https://www.gravatar.com/avatar/ac961ac352f787d0f6f55cb8aec38474?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
      "small": "https://www.gravatar.com/avatar/ac961ac352f787d0f6f55cb8aec38474?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/246/users/504" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer V_h3TWqkeUp4PxJDFbMInZRZ68rp24ZGsRolJfqjE-M" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/:id

GET /1.1/246/users/504
Accept: application/json
Content-Type: application/json
Authorization: Bearer V_h3TWqkeUp4PxJDFbMInZRZ68rp24ZGsRolJfqjE-M

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": 504,
  "email": "marijapcksqrbd@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1573559025,
  "updated_at": 1573559025,
  "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/8037cb0639aeaa866c4a09acd76b0d53?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/8037cb0639aeaa866c4a09acd76b0d53?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/8037cb0639aeaa866c4a09acd76b0d53?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/8037cb0639aeaa866c4a09acd76b0d53?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/8037cb0639aeaa866c4a09acd76b0d53?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/8037cb0639aeaa866c4a09acd76b0d53?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/247/users/current" -X GET \
    -H "Host: api.timelyapp.com" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer bbVMmkfrk4ZCsjQ0OTQzEk8hb9wHXbxihhC1CbnSfz4" \
    -H "Cookie: "

Endpoint

GET /1.1/:account_id/users/current

GET /1.1/247/users/current
Accept: application/json
Content-Type: application/json
Authorization: Bearer bbVMmkfrk4ZCsjQ0OTQzEk8hb9wHXbxihhC1CbnSfz4

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": 506,
  "email": "marijadbumeuij@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1573559025,
  "updated_at": 1573559025,
  "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/bb89132e3d5e2c0ba7affdcb8cc421a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/bb89132e3d5e2c0ba7affdcb8cc421a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/bb89132e3d5e2c0ba7affdcb8cc421a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/bb89132e3d5e2c0ba7affdcb8cc421a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/bb89132e3d5e2c0ba7affdcb8cc421a9?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/bb89132e3d5e2c0ba7affdcb8cc421a9?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/249/users/510" -d '{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":233,"hour_rate":10}]},"admin":{"id":248,"email":"notifications@timelyapp.com","created_at":"2019-11-12T12:43:47.000+01:00","updated_at":"2019-11-12T12:43:47.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 aMJzql6awBZ6SWi039KYeqHXJ6IO-gJEEfIeeVLBXlQ" \
    -H "Cookie: "

Endpoint

PUT /1.1/:account_id/users/:id

PUT /1.1/249/users/510
Accept: application/json
Content-Type: application/json
Authorization: Bearer aMJzql6awBZ6SWi039KYeqHXJ6IO-gJEEfIeeVLBXlQ

Parameters

{"user":{"name":"Robin","user_level":"normal","admin":false,"projects":[{"project_id":233,"hour_rate":10}]},"admin":{"id":248,"email":"notifications@timelyapp.com","created_at":"2019-11-12T12:43:47.000+01:00","updated_at":"2019-11-12T12:43:47.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": 510,
  "email": "marijartcpyxho@timelyapp.com",
  "name": "Marija Petrovic",
  "active": false,
  "day_view_onboarded": true,
  "memory_onboarded": true,
  "created_at": 1573559026,
  "updated_at": 1573559026,
  "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/0097c66f0203fcceebe7378efb1f5c68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "large": "https://www.gravatar.com/avatar/0097c66f0203fcceebe7378efb1f5c68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_large_retina-d4612e316dfb7aecf35477055a2987158899c94e147efe7e5960d605dc37b674.jpg&s=200",
    "medium_retina": "https://www.gravatar.com/avatar/0097c66f0203fcceebe7378efb1f5c68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "medium": "https://www.gravatar.com/avatar/0097c66f0203fcceebe7378efb1f5c68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_medium_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=50",
    "small_retina": "https://www.gravatar.com/avatar/0097c66f0203fcceebe7378efb1f5c68?d=http%3A%2F%2Fapp.timelyapp.local%2Fassets%2Fthumbs%2Fuser_small_retina-4715ba0edcfabca71404b6c34fa565f9edcd98f3dcea355e3695445ee5a3238b.jpg&s=25",
    "small": "https://www.gravatar.com/avatar/0097c66f0203fcceebe7378efb1f5c68?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.