1. Home
  2. Account Management
  3. Tools
  4. API Clock, Project Timers & Records

API Clock, Project Timers & Records

API documentation hub

Retrieve clock shifts and project timers, inspect record history, and generate expense-receipt PDFs.

On this page

  1. 7. Clock & shifts
  2. 12. Project timers
  3. 13. Records

7. Clock & shifts

Clock endpoints authenticate with the apikey only (no Bearer token). The javadoc documents the header as Authorization: <apikey>.

GET /clock/shift/user/{UserID}

curl -s "$API_BASE/clock/shift/user/101" \
  -H "Authorization: $API_KEY"

Returns on-clock status, clock-in / break timestamps (GMT + local), location, IP, photo info, alerts, hours for the current shift and today. Requires admin profile access to the target user.

GET /clock/shift/users

Parameter In Notes
UserList query Comma-separated user IDs
AdminUserID query Limit to users supervised by this manager
curl -s "$API_BASE/clock/shift/users?UserList=101,102&AdminUserID=50" \
  -H "Authorization: $API_KEY"


12. Project timers

GET /project/timers/{UserID}

Parameter In Notes
UserID path Required
CustomerID, ProjectID, AccountCodeID query Optional numeric csv filters
curl -s "$API_BASE/project/timers/101?CustomerID=10&ProjectID=200" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY"

Requires admin access to the target user.



13. Records

Revision history

curl -s "$API_BASE/record/hourly/history/9001" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s "$API_BASE/record/project/history/9002" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

curl -s "$API_BASE/record/expense/history/9003" \
  -H "Authorization: Bearer $TOKEN" -H "apikey: $API_KEY"

Requires admin access to the employee who owns the record. Invalid RecordID or missing permission returns messages in errors.

Expense receipt PDF

GET /record/expense/receipt/{RecordID}

Parameter Default Values
Orientation PORTRAIT PORTRAIT, LANDSCAPE
curl -s "$API_BASE/record/expense/receipt/9003?Orientation=LANDSCAPE" \
  -H "Authorization: Bearer $TOKEN" \
  -H "apikey: $API_KEY"

Response uses report-service fields (Msg, MsgType, Data with FileURL / RedirectURL / FileName on success).


API documentation hub

Updated on August 20, 2026
Was this article helpful?

Related Articles