Search your tasks by customer
Searches the caller's allocated tasks by the name, nickname or number of their customer.
Returns tasks the CALLER is allocated to whose customer's name, nickname or number contains searchText — but only for customers whose status type is Customer (system ID 1) or Partner (3); tasks of supplier, import or multi-customer-project customers are never returned, even with an empty searchText. searchAll=true drops the allocation filter and needs RegistrationAllTasks. IsFavourite is always null.
Use it to:
- "Type the customer, get the tasks" picker in a time-tracking client
Not for:
- Search by task name / number →
GET /v1/task/search-for-time-tracking - Customer already known by ID →
GET /v1/task/search-for-time-tracking-by-customer-id
Behaviour:
- Idempotent.
- Safe to retry.
- Consistency: eventual
Next: POST /v1/task/registration, POST /v1/time-registration
See also: GET /v1/task/search-by-project, GET /v1/task/search-for-time-tracking-by-customer-id
Not yet documented: behaviour → consistency; request → query params.
curl -X GET "https://app3.timelog.com/your-account/api/v1/task/search-by-customer?searchText=%22%22&searchAll=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-by-customer?searchText=%22%22&searchAll=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-by-customer?searchText=%22%22&searchAll=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-by-customer?searchText=%22%22&searchAll=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-by-customer?searchText=%22%22&searchAll=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-by-customer
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 the task's customer name, nickname and number (LIKE '%text%'). Empty = every allocated task of a Customer/Partner-type customer.
Filters on CustomerRead.Name | CustomerRead.NickName | CustomerRead.No (of the task's customer) (contains).
true = all tasks, not only the caller's allocations. Needs privilege RegistrationAllTasks.
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 the task's customer name, nickname and number (LIKE '%text%'). Empty = every allocated task of a Customer/Partner-type customer.
Filters on CustomerRead.Name | CustomerRead.NickName | CustomerRead.No (of the task's customer) (contains).
true = all tasks, not only the caller's allocations. Needs privilege RegistrationAllTasks.
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.