Home > Help > Tempo API Reference > Entries REST API

/entries GET

Returns a list of entries for the default ‘context’ of a new session in Tempo. The basic gist here is that the entries you’ll get back from calling GET on /entries will just be for the last week, and just for the current user. Results are paginated.

Beta Change

This method will now provide only the listing of entries for the current user, ordered by occurred_on DESC, created_at DESC. These are entries created by the user, or entries assigned to the user.

This method had previously provided the entries visible in the default ‘context’, which is now the default result set seen on the reports screen (the default report), see GET /reports.

/entries POST

Enables you to create a new time or timer entry.

If you want to create a new entry, you might supply a piece of XML like this:

<entry>
  <hours>5.0</hours>
  <notes>client meeting in NYC to discuss project requirements</notes>
  <project-id>4096</project-id>
  <tag-s>meetings discovery</tag-s>
</entry>

By using our text-entry syntax this would get even simpler:

<entry>
  <command>client meetings in NYC to discuss project requirements #project_name @meetings @discovery</command>
</entry>

Not all fields may be updated directly; these are:

:created_at, :creator_id, :id, :is_locked, :is_timing, :source, :updated_at

/entries/new GET

Simply produces an XML document providing default values for a new entry for the current user. Not required for creating an entry, but probably instructive, and helpful in that it provides some defaults you may wish to use.

/entries/search POST

Beta – Removed/Redirected

Due to many understandable complaints, we’re changing this to HTTP GET, and redirecting the request to /reports/search. GET requests will be redirected, POST requests will be ignored, and eventually this method will be removed.

When requesting a set of entries from Tempo via search, you must provide a Context XML document. This is basically a set of parameters telling Tempo which entries you want. It allows you to specify which users to look at, projects, tags, and the date range. Here’s a full example of the options:

<?xml version="1.0" encoding="UTF-8"?>
<context>
  <interval>last7days</interval>
  <start-date>2008-01-01</start-date>
  <end-date>2008-06-01</end-date>
  <project-ids type="array">
    <project-id type="integer">1024</project-id>
    <project-id type="integer">2048</project-id>
    <project-id type="integer">8192</project-id>
  </project-ids>
  <user-ids type="array">
    <user-id type="integer">1024</user-id>
    <user-id type="integer">2048</user-id>
  </user-ids>
  <tags type="array">
    <tag>tempo</tag>
    <tag>support</tag>
  </tags>
  <exclude-tags type="array">
    <exclude-tag>discovery</exclude-tag>
    <exclude-tag>internal</exclude-tag>
  </exclude-tags>
</context>

Note: It’s important that you specify the attribute type="array" for the following grouped attributes:
user-ids, project-ids, tags and exclude-tags.

Here’s an example of how you’d execute the search using curl, assuming you saved your XML in a file called ‘context.xml’:

curl -k -X POST -T context.xml -H 'Content-Type:application/xml' \
  -H 'Accept:application/xml' --user login:password \
  https://hotdogzllc.keeptempo.com/entries/search

/entries/search GET

Beta – New

This is a new method, only available in beta.

Redirects to /reports/search GET. Exists just to help migrate to beta from /entries/search POST.

/entries/:id GET

Request an entry by ID, i.e. /entries/1024.

/entries/:id PUT

Allows you to update an entry by posting an entry object to the collection member, i.e. /entries/1024.

For the list of attributes that can and cannot be updated, see /entries GET.

/entries/:id DELETE

Allows you to delete an entry by ID.

/entries/:id/edit GET

Supplies a description of the entry object in its current state.

/entries/:id/lock POST

Allows you to lock an entry.

/entries/:id/unlock POST

Allows you to unlock an entry.

/entries/:id/start POST

Causes the entry to start a timer. Will cause any other running timer to stop, as a consequence. Timing is additive, so any time logged will be added to the current value stored in hours when the timer is stopped.

/entries/:id/stop POST

Stops an entry’s timer. Timing is additive, so stopping the timer causes the time to be added to the value already present in the entry’s hours attribute.