Search your tasks for time tracking
Searches the tasks the caller is allocated to by task name or number, newest task first.
The task picker of a time-tracking client: tasks the CALLER is allocated to whose name or number contains searchText. searchAll=true drops the allocation filter and needs the privilege RegistrationAllTasks. includeFavouriteOnly=true keeps only the caller's favourites; IsFavourite is filled. Unlike the project-header sibling, this search IS scoped to the caller.
Use it to:
- Type-ahead task picker before POST /v1/task/registration or POST /v1/time-registration
Not for:
- Tasks of one customer →
GET /v1/task/search-for-time-tracking-by-customer-id - Search by project or customer NAME →
GET /v1/task/search-by-project/ searchbycustomer - Most recently used tasks →
GET /v1/task/get-recently-registered
Behaviour:
- Idempotent.
- Safe to retry.
- Consistency: eventual
Next: POST /v1/task/registration, POST /v1/time-registration
See also: GET /v1/task/get-recently-registered, GET /v1/task/search-for-time-tracking-by-customer-id, GET /v1/project-header/search-for-time-tracking
Not yet documented: behaviour → consistency; request → query params.
curl -X GET "https://app3.timelog.com/your-account/api/v1/task/search-for-time-tracking?searchText=%22%22&searchAll=false&includeFavouriteOnly=false&$expand=project&$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/search-for-time-tracking?searchText=%22%22&searchAll=false&includeFavouriteOnly=false&$expand=project&$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/search-for-time-tracking?searchText=%22%22&searchAll=false&includeFavouriteOnly=false&$expand=project&$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/search-for-time-tracking?searchText=%22%22&searchAll=false&includeFavouriteOnly=false&$expand=project&$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/search-for-time-tracking?searchText=%22%22&searchAll=false&includeFavouriteOnly=false&$expand=project&$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,
"ID": "123e4567-e89b-12d3-a456-426614174000",
"Name": "John Doe",
"No": "example_string",
"IsFixedPrice": true,
"IsDefaultBillable": true,
"AdditionalTextIsRequired": true,
"ParentFullName": "John Doe",
"ProjectID": 123,
"Project": {
"ProjectID": 123,
"ID": "123e4567-e89b-12d3-a456-426614174000",
"Name": "John Doe",
"No": "example_string",
"ExpenseIsBillable": "null",
"CustomerID": 123,
"Customer": {
"CustomerID": 123,
"ID": "123e4567-e89b-12d3-a456-426614174000",
"Name": "John Doe",
"No": "example_string",
"DefaultMileageDistance": 25,
"CustomerStatusID": 123,
"VATNo": "example_string",
"OrganizationNo": "example_string"
},
"MainContractId": 123
},
"ParentTaskID": "null",
"IsTravelTimeTask": true,
"IsFavourite": "null"
},
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
],
"Actions": [
{}
]
}
],
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v1/task/search-for-time-tracking
Target server for requests. Edit to use your own host.
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.
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.Substring matched against task name and task number (LIKE '%text%'; % and _ act as wildcards). Empty = no text filter.
Filters on TaskRead.Name | TaskRead.No (contains).
true = all tasks, not only the caller's allocations. Needs privilege RegistrationAllTasks.
true = only tasks the caller marked as favourite.
Filters on TaskRead.IsFavourite (eq).
Only project is meaningful.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
| project | project | Fill Project (ProjectHeaderRead) and its Customer on every entity; otherwise null. |
Page number.
Page size. No maximum in the API layer.
Request Preview
Response
Response will appear here after sending the request
Authentication
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 Parameters
Substring matched against task name and task number (LIKE '%text%'; % and _ act as wildcards). Empty = no text filter.
Filters on TaskRead.Name | TaskRead.No (contains).
true = all tasks, not only the caller's allocations. Needs privilege RegistrationAllTasks.
true = only tasks the caller marked as favourite.
Filters on TaskRead.IsFavourite (eq).
Only project is meaningful.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
project | project | Fill Project (ProjectHeaderRead) and its Customer on every entity; otherwise null. |
projectPage number.
Page size. No maximum in the API layer.
Responses
Paging values. They are returned as STRINGS, for example "TotalRecord": "12".
Omitted (not []) when the list is empty.