ProjectsSearch projects for expense or travel registration

Search projects for expense or travel registration

Lists the projects the caller can book an expense or mileage on — their allocated projects by recent use, or (searchAll) every active project by name.

The project picker of an expense or mileage client; the ProjectID, MainContractId and ExpenseIsBillable it returns feed POST /v1/project-header/employee-expense / .create. Without searchAll it is identical to search-for-time-tracking-order-by-recent-registration: projects with a task the caller is allocated to, ordered by the caller's latest time registration. With searchAll=true — allowed only when the account feature EnableAllEmployeesRegisterOnAllActiveProjects is on — it returns every active, non-template project (no task, allocation or contract needed), ordered by project NAME, and the ExpenseIsBillable / MainContractId values come straight from the project row.

Use it to:

  • Project picker in an expense or mileage app

Not for:

  • Restrict to one customer → GET /v1/project-header/search-for-expense-travel-registration-by-customer-id-order-by-recent-registration

Behaviour:

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

Next: POST /v1/project-header/employee-expense, POST /v1/project-header/mileage-registration

See also: GET /v1/project-header/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; response → variants.

curl -X GET "https://app3.timelog.com/your-account/api/v1/project-header/search-for-expense-travel-registration-order-by-recent-registration?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-expense-travel-registration-order-by-recent-registration
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

true = all active non-template projects, ordered by name. Needs the account feature EnableAllEmployeesRegisterOnAllActiveProjects.

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

true = all active non-template projects, ordered by name. Needs the account feature EnableAllEmployeesRegisterOnAllActiveProjects.

$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