CustomersSearch customers for time tracking

Search customers for time tracking

Searches the customers that have tasks the calling user is allocated to (or all customers with tasks, with searchAll).

The customer picker of time registration. By default it returns customers that have at least one task the CALLER is allocated to, matched by name, nickname or number. With searchAll=true it returns every customer that has any task — this needs the 'register on all tasks' privilege. Results are ordered by CustomerID, newest first; for "most recently used first" use GET /v1/customer/search-for-time-tracking-order-by-recent-registration.

Use it to:

  • Customer drop-down in a time-tracking client, before choosing project and task

Not for:

  • Full customer register → GET /v1/customer

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Consistency: eventual

Next: POST /v1/time-registration

See also: GET /v1/customer/search-for-time-tracking-order-by-recent-registration, GET /v1/customer/search-for-expense-travel-registration-order-by-recent-registration

Not yet documented: behaviour → consistency; request → query params.

curl -X GET "https://app3.timelog.com/your-account/api/v1/customer/search-for-time-tracking?searchText=%22%22&searchAll=false&$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "TotalRecord": "example_string",
    "TotalPage": "example_string",
    "PageNumber": "example_string"
  },
  "Entities": [
    {
      "Properties": {
        "CustomerID": 123,
        "ID": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "John Doe",
        "No": "example_string",
        "DefaultMileageDistance": 25,
        "CustomerStatusID": 123,
        "VATNo": "example_string",
        "OrganizationNo": "example_string"
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v1/customer/search-for-time-tracking
GET
Base URLstring

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

Bearer Token
Bearer Tokenstring
Required

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.

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
searchTextstring

Substring matched against name, nickname and customer number (LIKE '%text%'). Empty = no text filter. Filters on CustomerRead.Name | NickName | CustomerRead.No (contains).

query
searchAllboolean

true = all customers with tasks, not only those the caller is allocated to. Needs privilege RegistrationAllTasks.

query
$pageinteger

Page number.

query
$pagesizeinteger

Page size. No maximum enforced 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.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Query Parameters

searchTextstring

Substring matched against name, nickname and customer number (LIKE '%text%'). Empty = no text filter.

Filters on CustomerRead.Name | NickName | CustomerRead.No (contains).

searchAllboolean

true = all customers with tasks, not only those the caller is allocated to. Needs privilege RegistrationAllTasks.

$pageinteger

Page number.

$pagesizeinteger

Page size. No maximum enforced in the API layer.

Responses

Propertiesobject

Paging values. They are returned as STRINGS, for example "TotalRecord": "12".

Entitiesarray

Omitted (not []) when the list is empty.

Linksarray