ProjectsSearch projects for time tracking

Search projects for time tracking

Lists projects that have at least one task, matched by name or number, newest project first.

For a list scoped to the caller's allocations and ordered by their latest registration, use GET /v1/project-header/search-for-time-tracking-order-by-recent-registration.

Use it to:

  • Project drop-down before choosing a task

Not for:

  • Projects the caller is allocated to → GET /v1/project-header/search-for-time-tracking-order-by-recent-registration
  • Projects of one customer → GET /v1/project-header/search-for-time-tracking-by-customer-id

Behaviour:

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

Next: POST /v1/time-registration

See also: GET /v1/project-header/search-for-time-tracking-order-by-recent-registration, GET /v1/project-header/search-for-time-tracking-by-customer-id, GET /v1/customer/search-for-time-tracking

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

curl -X GET "https://app3.timelog.com/your-account/api/v1/project-header/search-for-time-tracking?searchText=%22%22&searchAll=false&$expand=customer&$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": {
        "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
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v1/project-header/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 project name and number (LIKE '%text%'). Empty = no text filter. Filters on ProjectHeaderRead.Name | ProjectHeaderRead.No (contains).

query
searchAllboolean

Requests all projects; needs privilege RegistrationAllTasks. Has no effect on the rows returned.

query
$expandstring

Only customer is meaningful. Allowed values: | Value | Name | Meaning | |---|---|---| | customer | customer | Fill Customer on every entity (otherwise null). |

Options: customer
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 project name and number (LIKE '%text%'). Empty = no text filter.

Filters on ProjectHeaderRead.Name | ProjectHeaderRead.No (contains).

searchAllboolean

Requests all projects; needs privilege RegistrationAllTasks. Has no effect on the rows returned.

$expandstring

Only customer is meaningful.

Allowed values:

ValueNameMeaning
customercustomerFill Customer on every entity (otherwise null).
Allowed values:customer
$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