Read a worklog

GEThttps://<your-url>/api/v2/worklogs/{worklog}

MCP id worklogs.showAlso on this path: PATCH Correct a worklog, DELETE Delete a worklog

Returns one worklog.

Token scope: api:read:times
Without it: 403 insufficient-token-scope.
Permission: hours::read
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One worklog with its justifications and its budget

curl -G \
  'https://<your-url>/api/v2/worklogs/1' \
  --data-urlencode 'view=detail' \
  --data-urlencode 'include=budget,task,user' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/worklogs/1?view=detail&include=budget%2Ctask%2Cuser', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/worklogs/1?view=detail&include=budget%2Ctask%2Cuser');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/worklogs/1?view=detail&include=budget%2Ctask%2Cuser',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "date": "2026-09-10",
    "minutes": 150,
    "description": "Reviewed the invoice export and fixed the rounding",
    "project_id": 12,
    "project": null,
    "budget_id": 1,
    "budget": null,
    "task_id": 88,
    "task": null,
    "work_item_id": 41,
    "work_item": null
  }
}

13 more fields, listed under Response

reason and billable_change_reason are detail-view fields, so ?view=detail is what fetches the justifications a list row omits. An entry belonging to another employee is 404 unless the caller holds times::update_others or times::delete_others: the row is invisible, so its existence stays invisible. project and work_item are always expanded; budget, task and user expand under ?include=, and each additionally requires the read permission and token scope of its own prefix.

Path parameters

worklogintegerRequired

The Time's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a Time in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

datedate (YYYY-MM-DD)

The calendar day the work happened.

minutesinteger

Duration in minutes, between 1 and 1440.

descriptionstring≤ 255

What the employee worked on.

project_idinteger or null

Project the hours are booked against; null once that project is deleted.

projectRef or ProjectSummary or null

The project the hours are booked against, always expanded. Its customer_id is the customer to fetch with GET /api/v2/customers/{customer}; the customer itself is not nested.

budget_idinteger or nullServer-assigned

Budget the hours are invoiced against. Derived from the task, never accepted on a write; null when no task is set or the budget is deleted.

budgetRef or BudgetSummary or null

The budget the hours are invoiced against. Expanding it with ?include=budget additionally requires the budgets::read permission and a token scope covering the budgets prefix.

task_idinteger or null

Task the hours are booked on; null when the entry is not attached to one, or once that task is deleted.

taskRef or TaskSummary or null

The task the hours are booked on. Expanding it with ?include=task additionally requires the kanban::manage_self permission and a token scope covering the kanban prefix, and is limited to the tasks you can see on the tasks collection.

work_item_idinteger or null

Work item the hours are attached to; null when the entry is not attached to one, or once that work item is deleted.

work_itemRef or WorkItemSummary or null

The work item the hours are attached to, always expanded.

user_idinteger or nullServer-assigned

Employee the hours belong to. Assigned on create (from the authenticated user, or from on_behalf_of_user_id) and never writable afterwards; reassigning a worklog is a DELETE plus a POST.

userRef or UserSummary or null

The employee the hours belong to. Expanding it with ?include=user additionally requires the users::read permission and a token scope covering the users prefix.

is_not_billableboolean

Whether these hours are excluded from invoicing. Inferred from the task's is_billable flag (false without a task) on create and again whenever task_id is sent. Sending a value that differs from the inferred or current one requires billable_change_reason and puts the entry in a reviewer's queue; without it the write is a 422 on /billable_change_reason.

is_overtimeboolean

Whether the hours count as overtime. Sending it without the times::write_overtime permission leaves it false and adds an input_ignored warning rather than failing the write.

exceeded_budgetboolean

Whether the entry was booked knowing it exceeds its budget. Set on create only, and true whenever a reason is sent; setting it puts the entry in a reviewer's queue.

reasonstring or nullDetail onlyMultiline

Why the budget overrun was accepted. Sending it on create marks the entry as exceeding its budget. Once a reviewer has settled the entry it can no longer be changed: a PATCH that does answers 409 reason_reviewed.

billable_change_reasonstring or nullDetail onlyMultiline

Why the inferred billability was overridden. Required whenever is_not_billable is sent with a value that differs from the inferred or current one, on create and on PATCH alike; the override puts the entry in a reviewer's queue, reopening one a reviewer had already settled.

reviewed_byinteger or nullServer-assigned

The reviewer who settled the entry, once one has. Set by the review queue in plnnrly; this API exposes no way to write it.

invoice_idinteger or nullServer-assigned

The invoice these hours were billed on, once they have been. While it is set, the entry is locked: a write answers 409 with conflict.reason locked_by_invoice.