Chime API Documentation

Time tracking

List time entries

Returns the time entries in the account.

Resource URL
GET
/time-tracking
GET Parameters
Name Description
projects integers CSV The ID number of the projects with the time entries to fetch; separated by commas.
loggers integers CSV The ID number of the time entries authors; separated by commas.
types strings CSV The types of time entries: BILLABLE, UN_BILLABLE, SETTLED; separated by commas.
milestones integers CSV The ID number of the milestones; separated by commas.
labels integers CSV The ID number of the labels; separated by commas.
categories strings CSV The name of the time entries categories: SOURCE, TICKETS, GENERAL; separated by commas.
dates YYYY-MM-DD in gmt The time entry date in YYYY-MM-DD format. If only one date is given, the list will contain entries from the beginning up to this date.
Example
Request
GET
https://pickles.getchime.com/api/time-tracking?projects=13&milestones=27&loggers=9&labels=4,5&dates=2016-01-01,2016-02-01&types=BILLABLE,UN_BILLABLE&categories=SOURCE,TICKETS
Sample Response
{
  "success": true,
  "data": {
    "id": 1,
    "type": "BILLABLE",
    "value": 120,
    "category": "TICKETS",
    "created": "2016-01-15T07:58:08",
    "comment": "Time entry comment",
    "entryDate": "2016-01-15",
    "logger": {
      "id": 9,
      "avatarSmall": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/30/30/AVATAR.png",
      "avatarLarge": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/60/60/AVATAR.png",
      "avatarMicro": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/16/16/AVATAR.png",
      "shortName": "Owner L.",
      "firstName": "Owner",
      "lastName": "Lastname"
    },
    "milestone": {
      "id": 27,
      "name": "UPCOMMING"
    },
    "project": {
      "id": 13,
      "name": "Chime Project"
    },
    "labels": [
      {
        "id": 4,
        "name": "label1"
      },
      {
        "id": 5,
        "name": "label2"
      }
    ]
  }
}

Post

Adds a time entry.

Resource URL
POST
/time-tracking
POST Parameters
Name Description
projectId Required Integer The ID number of the project.
time Required Integer The value (in minutes) of a time trackinkg entry.
entryDate YYYY-MM-DD in gmt The time entry date in YYYY-MM-DD format.
type String The type of added time entry: BILLABLE or UN_BILLABLE.
comment String Time entry comment.
labels Strings CSV The list of labels. If a given label does not exist, it will be created.
milestoneId Integer The ID number of the milestone.
Example
Request
POST
https://pickles.getchime.com/api/time-tracking
{
  "projectId": 1,
  "time": 60,
  "entryDate": "2016-05-01",
  "type": "UN_BILLABLE"
  "comment": "New time entry",
  "labels": [
    "Label1",
    "Label2"
  ],
  "milestoneId": 11  
}
Sample Response
{
  "success": true,
  "data": {
    "id": 1,
    "type": "UN_BILLABLE",
    "value": 60,
    "category": "GENERAL",
    "created": "2016-05-01T10:10:35",
    "comment": "test2",
    "entryDate": "2016-05-01",
    "logger": {
      "id": 1,
      "avatarSmall": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/30/30/AVATAR.png",
      "avatarLarge": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/60/60/AVATAR.png",
      "avatarMicro": "https://pickles.getchime.com/image-server/user/0/0/0/0/0/0/4/15af6594e07a1e6e28ea253cbf881cec/w/16/16/AVATAR.png",
      "shortName": "Owner L.",
      "firstName": "Owner",
      "lastName": "Lastname"
    },
    "milestone": {
      "id": 11,
      "name": "UPCOMMING"
    },
    "project": {
      "id": 1,
      "name": "Chime Project"
    },
    "labels": [
      {
        "id": 1,
        "name": "Label1"
      },
      {
        "id": 2,
        "name": "Label2"
      }
    ]
  }
}

Update time entries

Update time entries.

Resource URL
PUT
/time-tracking
POST Parameters
Name Description
ids Required array of Integers The ID numbers of the time entries.
type Required string The new type of time tracking entries. Available values: BILLABLE, UN_BILLABLE, SETTLED
Example
Request
PUT
https://pickles.getchime.com/api/time-tracking
{
  "ids": [1, 2],
  "type": "UN_BILLABLE"
}
Sample Response
{
  "success": true,
}
Create a free account
Leave a message

Have a question about Chime or one of our apps? Leave a message here and we'll get back to you as soon as we can.