Search tasks by filter

Searches all tasks of the account by project, task, status, active / billable flag and plan dates.

A paged task search over EVERY task of the account, returning the extended task model (status, dates, project number, parent). Filter semantics worth knowing: - startDate / endDate select tasks that lie INSIDE the window (start >= startDate, end <= endDate) — not tasks that overlap it. Tasks without a start (or end) date never match a startDate (endDate) filter. - taskStatus takes the INTEGER 0-4; the response returns the status NAME.

Use it to:

Incremental task sync by project: ?projectId=… (each page re-read with $page)
Resolve a task by GUID: ?taskGuid=…
List open tasks of a period for a planning integration: ?taskStatus=1&startDate=…&endDate=…

Not for:

Tasks the caller may register time on → GET /v1/task/search-for-time-tracking
One task by integer ID with its project object → GET /v1/task/{taskID}

Rules across fields:

Behaviour:

Idempotent.
Safe to retry.
Changes are visible to the next read immediately.

Call first: GET /v1/project/get-all

Next: GET /v1/task/{taskID}, PUT /v1/task/{taskID}

See also: GET /v1/task, GET /v1/TaskType

Not yet documented: request → query params.

curl -X GET "https://app3.timelog.com/your-account/api/v1/task/filter?projectId=123&taskId=123&taskGuid=123e4567-e89b-12d3-a456-426614174000&isActive=true&taskStatus=42&isBillable=true&startDate=2024-12-25T10%3A00%3A00Z&endDate=2024-12-25T10%3A00%3A00Z&$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app3.timelog.com/your-account/api/v1/task/filter?projectId=123&taskId=123&taskGuid=123e4567-e89b-12d3-a456-426614174000&isActive=true&taskStatus=42&isBillable=true&startDate=2024-12-25T10%3A00%3A00Z&endDate=2024-12-25T10%3A00%3A00Z&$page=1&$pagesize=10"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://app3.timelog.com/your-account/api/v1/task/filter?projectId=123&taskId=123&taskGuid=123e4567-e89b-12d3-a456-426614174000&isActive=true&taskStatus=42&isBillable=true&startDate=2024-12-25T10%3A00%3A00Z&endDate=2024-12-25T10%3A00%3A00Z&$page=1&$pagesize=10", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app3.timelog.com/your-account/api/v1/task/filter?projectId=123&taskId=123&taskGuid=123e4567-e89b-12d3-a456-426614174000&isActive=true&taskStatus=42&isBillable=true&startDate=2024-12-25T10%3A00%3A00Z&endDate=2024-12-25T10%3A00%3A00Z&$page=1&$pagesize=10", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app3.timelog.com/your-account/api/v1/task/filter?projectId=123&taskId=123&taskGuid=123e4567-e89b-12d3-a456-426614174000&isActive=true&taskStatus=42&isBillable=true&startDate=2024-12-25T10%3A00%3A00Z&endDate=2024-12-25T10%3A00%3A00Z&$page=1&$pagesize=10')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "Properties": {
    "TotalRecord": "example_string",
    "TotalPage": "example_string",
    "PageNumber": "example_string"
  },
  "Entities": [
    {
      "Properties": {
        "TaskID": 123,
        "TaskName": "John Doe",
        "TaskNo": "example_string",
        "ParentFullName": "John Doe",
        "IsActive": true,
        "TaskStatus": "NotStarted",
        "ProjectID": 123,
        "ProjectNo": "example_string",
        "IsFixedPrice": true,
        "StartDate": "2024-12-25T10:00:00Z",
        "EndDate": "2024-12-25T10:00:00Z",
        "IsDefaultBillable": true,
        "AdditionalTextIsRequired": true,
        "ID": "123e4567-e89b-12d3-a456-426614174000",
        "IsParent": true,
        "ParentTaskID": "null",
        "IsTravelTimeTask": true
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

GET

/v1/task/filter

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

query

projectIdinteger

Only tasks of this project. Must be > 0 (400 "Project ID must be greater than 0."). An unknown project gives an empty page. Filters on TaskExtendedRead.ProjectID (eq).

Format: int32

query

taskIdinteger

Only this task. Must be > 0 (400 "Task ID must be greater than 0."). Filters on TaskExtendedRead.TaskID (eq).

Format: int32

query

taskGuidstring

Only the task with this GUID. The empty GUID is rejected with 400. Filters on TaskExtendedRead.ID (eq).

Format: uuid

query

isActiveboolean

true = active tasks only, false = inactive only; omitted = both. Filters on TaskExtendedRead.IsActive (eq).

query

taskStatusinteger

Status as an INTEGER: 0 NotStarted, 1 InProgress, 2 OnHold, 3 Completed, 4 Cancelled. Outside 0-4: 400. Filters on TaskExtendedRead.TaskStatus (eq).

Format: int32

query

isBillableboolean

true = tasks whose NonBillable flag is 0, false = NonBillable 1; omitted = both. Filters on TaskExtendedRead.IsDefaultBillable (eq).

query

startDatestring

Only tasks whose start date is on or after this value. Must pass the date validity check (400 "Start Date is not a valid date."). Filters on TaskExtendedRead.StartDate (gte).

Format: date-time

query

endDatestring

Only tasks whose end date is on or before this value (400 "End Date is not a valid date." when invalid). Filters on TaskExtendedRead.EndDate (lte).

Format: date-time

Page number.

Page size. No maximum in the API layer.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.