Articles on: API

Worklog API

The Worklog API provides a unified interface for managing employee time entries via HTTP GET, supporting create, update, and delete operations.


This API captures comprehensive worklog details—including projects, activities, dates, and billable statuses—and returns responses in plain text. Secure access is enforced through authentication with a JIRA key.


By integrating the Worklog API, organizations can streamline payroll processing, reporting, and analytics, ensuring accurate worklog management and seamless data exchange with external systems.


Overview


API Type: REST
Supported Formats: XML
Method: GET
**JIRA Key: ** Generated in the app configuration


Request Parameters


Parameter

Type

Required

Description

action

string

Operation to perform: create , update , or delete .

apiKey

string

Your JIRA Key.

login

string

Employee login name.

id

long

Unique identifier for the worklog entry.

time

integer

✅ / ❌

Duration in minutes (e.g., 180).

projectCode

string

✅ / ❌

Project code (only projects with active status are accepted).

activity

string

✅ / ❌

Activity name. If not found, default activity will be used.

date

string

✅ / ❌

Worklog date in YYYY-MM-DD format.

comment

string

Equals to "Note" value in the daily-sheet.

billable

boolean

True / 1 for billable, otherwise false / 0 (default false)


Parameters time, projectCode, activity, and date are required for create and update operations only.


Error notifications appear in-app via the 🔔 bell icon in the top-right corner. Clicking it opens a dropdown list showing each message with its timestamp and details.



Operations


Create Worklog


Creates a new worklog for an employee.
Set action=create


Endpoint


Update Worklog


Updates an existing worklog.
Set action=update


Endpoint


Delete Worklog


Deletes an existing worklog.
Set action=delete


Endpoint



HTTP Response Codes

  • **2XX Success ** - Operation completed successfully.
  • **4XX Client Error ** - Likely an issue with the request, such as incorrect parameters or insufficient permissions. Returns an error message in text or XML format.
  • **5XX Server Error ** - Indicates a server issue. Report this error if encountered.


Updated on: 07/05/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!