List running timers

GEThttps://<your-url>/api/v2/timers

MCP id timers.indexAlso on this path: POST Start a timer

Returns the running timers, newest first by created_at.

Token scope: api:read:hours
Without it: 403 insufficient-token-scope.
Permission: hours::read
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: each include +1.
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: My running timers, with what they are timing

curl -G \
  'https://<your-url>/api/v2/timers' \
  --data-urlencode 'filter[user_id]=me' \
  --data-urlencode 'include=timeable' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/timers?filter[user_id]=me&include=timeable', {
  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/timers?filter[user_id]=me&include=timeable');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/timers?filter[user_id]=me&include=timeable',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "user": {
        "id": 1
      },
      "timeable_type": "work_item",
      "timeable_id": 41,
      "timeable": {
        "id": 1
      },
      "started_at": "2026-03-04T09:15:00Z",
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "links": {
        "…": "1 field of TimerLinks"
      }
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

A caller sees only their own rows unless they hold times::update_others, and that narrowing is applied before any client filter, before pagination and before the count. meta.page.total is always present, so with_total is not an accepted parameter. Neither is q (a timer has no text to search), nor meta, trashed or force; sending any of them is a 400. To find the timer on one record, send the type and id together: filter[timeable_type]=work_item&filter[timeable_id]=41; a lone half is a 400. A timer on a record type this API does not publish (an Outlook calendar event, which the agenda really does time) is returned with timeable_type set to outlook_event and timeable as the bare {"id": N} reference form, which ?include=timeable cannot expand.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

20 parameters in 5 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request.

Filters

=: equals
[in]: any of a comma-separated list
[gte][lte][lt]: at least, at most, less than

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[started_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lte]

When the stopwatch was started.

filter[timeable_id]integer=[in]

Id of the timed record. Send together with timeable_type.

A comma-separated list of at most 100 values.

filter[timeable_type]string

Type of the timed record. Send together with timeable_id.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

filter[user_id]integer=[in]

Whose timers to return. Accepts the literal me, and defaults to the authenticated user. Naming another employee requires the times::update_others permission.

A comma-separated list of at most 100 values.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: created_at

Key	Sorts by
`created_at`	When the timer row was created, newest first.
`started_at`	When the stopwatch was started, oldest first.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`timeable`	The work item or planning event being timed.	+1
`user`	The employee the timer belongs to.	+1

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 page of TimerList rows.

dataarray of TimerList

The rows, each a TimerList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a TimerList: 10 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
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