Search your tasks of one project for time tracking
Searches the caller's allocated tasks of one project by task name or number, newest task first.
search-for-time-tracking restricted to the tasks of projectID. projectID is required (omitted → 404 "No action was found", captured); an unknown or foreign project gives an empty page (without searchAll). Allocation scope, searchAll + RegistrationAllTasks, includeFavouriteOnly and ordering by TaskID descending are as on the sibling.
Use it to:
- Task picker after the user chose a project (
GET /v1/project-header/search-for-time-tracking-order-by-recent-registration)
Not for:
- Project chosen by NAME →
GET /v1/task/search-by-project - Recent tasks first →
GET /v1/task/search-for-time-tracking-by-project-id-order-by-recent-registration - Travel-time tasks first →
GET /v1/task/search-for-time-tracking-by-project-id-order-by-travel-time-task
Behaviour:
- Idempotent.
- Safe to retry.
- Consistency: eventual
- As
GET /v1/task/search-for-time-tracking(denormalised search tables).
Call first: GET /v1/project-header/search-for-time-tracking-order-by-recent-registration
Next: POST /v1/task/registration, POST /v1/time-registration
See also: GET /v1/task/search-for-time-tracking, GET /v1/task/search-for-time-tracking-by-project-id-order-by-recent-registration, GET /v1/task
Not yet documented: behaviour → consistency; examples; request → query params.
curl -X GET "https://app3.timelog.com/your-account/api/v1/task/search-for-time-tracking-by-project-id?projectID=123&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-by-project-id?projectID=123&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-by-project-id?projectID=123&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-by-project-id?projectID=123&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-by-project-id?projectID=123&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
}
{
"Message": "No HTTP resource was found that matches the request URI 'https://app{server-number}.timelog.com/{account}/api/v1/task/search-for-time-tracking-by-project-id'.",
"MessageDetail": "No action was found on the controller 'Task' that matches the request."
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v1/task/search-for-time-tracking-by-project-id
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.The project. Required: omitted → 404 rest.action-not-matched. Unknown ID → empty page.
Filters on TaskRead.ProjectID (eq).
Substring matched against task name and task number (LIKE '%text%'). Empty = no text filter.
Filters on TaskRead.Name | TaskRead.No (contains).
true = all the project's 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. The customer inside Project is always requested by this operation, but Project itself still needs $expand=project.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
| project | project | Fill Project (ProjectHeaderRead) with its Customer on every entity; otherwise Project is 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
The project. Required: omitted → 404 rest.action-not-matched. Unknown ID → empty page.
Filters on TaskRead.ProjectID (eq).
Substring matched against task name and task number (LIKE '%text%'). Empty = no text filter.
Filters on TaskRead.Name | TaskRead.No (contains).
true = all the project's 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. The customer inside Project is always requested by this operation, but Project itself still needs $expand=project.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
project | project | Fill Project (ProjectHeaderRead) with its Customer on every entity; otherwise Project is 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.