ProjectsGet a project

Get a project

Returns one project by its integer ProjectID, if the caller may see it.

Reads the project header (ProjectRead). Since 2026-09-03 the caller must have access to the project under the same rule as the project pages (see auth). Add $expand=customer to embed the customer. Template projects are returned too, to template administrators.

Use it to:

  • Read a project after create-from-template or before an update
  • Resolve a ProjectID found on a time registration or payment

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Changes are visible to the next read immediately.

Call first: GET /v1/project/get-all

Next: PUT /v1/project/{projectID}, PUT /v1/project/{projectID}/status

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

Not yet documented: examples.

curl -X GET "https://app3.timelog.com/your-account/api/v1/project/123?$expand=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "ProjectID": 123,
    "ID": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "John Doe",
    "No": "example_string",
    "ExpenseIsBillable": true,
    "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"
    },
    "ContactID": 123,
    "Description": "example_string",
    "DepartmentID": "null",
    "ProjectManagerID": "null",
    "AccountManagerID": "null",
    "PartnerID": "null",
    "ProjectTypeID": "null",
    "ProjectCategoryID": "null",
    "BudgetWorkHours": 3.14,
    "BudgetWorkAmount": 3.14,
    "StartDate": "null",
    "EndDate": "null"
  },
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ],
  "Actions": [
    {}
  ]
}
GET
/v1/project/{projectID}
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.
path
projectIDinteger
Required

The project's integer ID.

Format: int32
query
$expandstring

customer — fill ProjectRead.Customer.

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.

Path Parameters

projectIDinteger
Required

The project's integer ID.

Query Parameters

$expandstring

customer — fill ProjectRead.Customer.

Responses

Propertiesobject

The REST v1 project: identifiers, name and number, customer and contact, the responsible people (project manager, account manager, partner), department, type and category, the work budget and the start/end dates. It does not carry status, contracts, tasks or financials. The TAF self link points to GET /v1/project/{ProjectID}; each entity also lists the four TAF actions create-from-template, validate-create-from-template, update-project and update-project-status.

Linksarray
Actionsobject[]