ProjectsSearch a customer's projects for expense or travel registration

Search a customer's projects for expense or travel registration

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

The project step of a customer → project picker in an expense or mileage client. Scoping, ordering, the searchAll account-feature gate and the field meanings are those of GET /v1/project-header/search-for-expense-travel-registration-order-by-recent-registration, restricted to customerID. Customer is always filled on every entity.

Use it to:

  • Customer → project picker in an expense app (customer from GET /v1/customer/search-for-expense-travel-registration-order-by-recent-registration)

Behaviour:

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

Call first: GET /v1/customer/search-for-expense-travel-registration-order-by-recent-registration

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

See also: GET /v1/project-header/search-for-expense-travel-registration-order-by-recent-registration

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

curl -X GET "https://app3.timelog.com/your-account/api/v1/project-header/search-for-expense-travel-registration-by-customer-id-order-by-recent-registration?customerID=123&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": {
        "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-by-customer-id-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
customerIDinteger
Required

Customer whose projects are returned. Omitted → 404 (no action matched). Unknown ID → empty list. Filters on ProjectHeaderRead.CustomerID (eq).

Format: int32
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 of the customer, ordered by name. Needs the account feature EnableAllEmployeesRegisterOnAllActiveProjects.

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

customerIDinteger
Required

Customer whose projects are returned. Omitted → 404 (no action matched). Unknown ID → empty list.

Filters on ProjectHeaderRead.CustomerID (eq).

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 of the customer, ordered by name. Needs the account feature EnableAllEmployeesRegisterOnAllActiveProjects.

$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