GetProjectByID

Project management service 1.8: Returns one project by its integer ProjectID, optionally with its external keys.


Service	Project management 1.8
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc`
SOAPAction	`http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetProjectByID`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Changes data	No
Safe to retry	Yes

How it works

Loads the project by integer ID and returns it as ProjectApiReadModel; with loadExternalKeys = true the project's external-system keys are included. No status, no actual hours or amounts are part of the model, and several members are wrong or empty - see the schema.

Parameters

Each parameter has one label: Required, Conditional (required depending on other values) or Optional. Send them in the order shown.

projectIDinteger

Required

Integer ID of the project.

loadExternalKeysboolean

Optional. Default false. true = include ExternalKeys.

tokenSecurityToken

Required

The token from GetToken: Initials, Expires and Hash, sent back unchanged.

Request

POST /{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc HTTP/1.1
Host: app{server-number}.timelog.com
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetProjectByID"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:pm="http://www.timelog.com/api/tlp/v1_8"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <pm:GetProjectByID>
      <pm:projectID>{projectID}</pm:projectID>
      <pm:loadExternalKeys>false</pm:loadExternalKeys>
      <pm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </pm:token>
    </pm:GetProjectByID>
  </soapenv:Body>
</soapenv:Envelope>

curl -X POST "https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H 'SOAPAction: "http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetProjectByID"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc"
SOAP_ACTION = '"http://www.timelog.com/api/tlp/v1_8/ProjectManagementService/GetProjectByID"'

envelope = """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:pm="http://www.timelog.com/api/tlp/v1_8"
                  xmlns:tok="http://www.timelog.com/api/tlp/v1_3">
  <soapenv:Body>
    <pm:GetProjectByID>
      <pm:projectID>{projectID}</pm:projectID>
      <pm:loadExternalKeys>false</pm:loadExternalKeys>
      <pm:token>
        <tok:Initials>{Initials from GetToken}</tok:Initials>
        <tok:Expires>{Expires from GetToken, unchanged}</tok:Expires>
        <tok:Hash>{Hash from GetToken}</tok:Hash>
      </pm:token>
    </pm:GetProjectByID>
  </soapenv:Body>
</soapenv:Envelope>"""

response = requests.post(
    URL,
    data=envelope.encode("utf-8"),
    headers={"Content-Type": "text/xml; charset=utf-8", "SOAPAction": SOAP_ACTION},
    timeout=60,
)
result = parse_result(response)  # see "Responses and errors"

Replace every {…} placeholder with your own value.

Response

The call returns the standard response envelope. Check ResponseState first: a failed call still returns HTTP 200.

ResponseStatestring

Required

Success, Invalid or Error.

ErrorCodeinteger

0 on success, otherwise the error code. See Errors.

ReturnProjectApiReadModel[]

Response<ProjectApiReadModel> with one item. IsReturnPaged false, TotalPageCount 1. Unknown ID: Error envelope - an empty Return with Success is only possible if the loader returns null.

Example response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetProjectByIDResponse xmlns="http://www.timelog.com/api/tlp/v1_8">
      <GetProjectByIDResult xmlns:a="http://api.timelog.com"
                            xmlns:b="http://www.timelog.com/api/tlp/v1_8"
                            xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:ProjectApiReadModel>
            <a:Action>Original</a:Action>
            <a:IsCustomFieldsLoaded>false</a:IsCustomFieldsLoaded>
            <a:CustomFields i:nil="true"/>
            <a:IsExternalKeysLoaded>false</a:IsExternalKeysLoaded>
            <a:ExternalKeys i:nil="true"/>
            <b:ID>3f2504e0-4f89-41d3-9a0c-305000000001</b:ID>
            <b:ProjectID>1001</b:ProjectID>
            <b:CustomerID>1001</b:CustomerID>
            <b:Name>Example </b:Name>
            <b:No>1001</b:No>
            <b:Description>Example</b:Description>
            <b:Link>Example</b:Link>
            <b:StartDate>2026-10-01T00:00:00</b:StartDate>
            <b:EndDate>2026-10-01T00:00:00</b:EndDate>
            <b:IsInternalProject>false</b:IsInternalProject>
            <b:ProjectManagerID>1001</b:ProjectManagerID>
            <b:AccountManagerID>1001</b:AccountManagerID>
            <b:DepartmentHandledByID>1001</b:DepartmentHandledByID>
            <b:DepartmentOrderedByID>1001</b:DepartmentOrderedByID>
            <b:TypeID>1001</b:TypeID>
            <b:CategoryID>1001</b:CategoryID>
            <b:StageID>1001</b:StageID>
            <b:LegalEntityID>1001</b:LegalEntityID>
            <b:PriceGroupID>1001</b:PriceGroupID>
            <b:ExchangeRate>0</b:ExchangeRate>
            <b:CurrencyID>1001</b:CurrencyID>
            <b:MainContractID>1001</b:MainContractID>
            <b:BudgetWorkHoursFixedPriceProject>0</b:BudgetWorkHoursFixedPriceProject>
            <b:BudgetWorkHoursFixedPriceTasks>0</b:BudgetWorkHoursFixedPriceTasks>
            <b:BudgetWorkHoursTimeAndMaterial>0</b:BudgetWorkHoursTimeAndMaterial>
            <b:BudgetWorkAmountFixedPriceProject>0</b:BudgetWorkAmountFixedPriceProject>
            <b:BudgetWorkAmountFixedPriceTasks>0</b:BudgetWorkAmountFixedPriceTasks>
            <b:BudgetWorkAmountTimeAndMaterial>0</b:BudgetWorkAmountTimeAndMaterial>
            <b:BudgetAmountExpenses>0</b:BudgetAmountExpenses>
            <b:BudgetAmountTravelExpenses>0</b:BudgetAmountTravelExpenses>
            <b:ProjectContactID>1001</b:ProjectContactID>
            <b:PurchaseOrderNumber>1001</b:PurchaseOrderNumber>
          </b:ProjectApiReadModel>
        </a:Return>
        <a:ReturnTypeDescription>ProjectApiReadModel</a:ReturnTypeDescription>
        <a:Request>…</a:Request>
        <a:ResponseState>Success</a:ResponseState>
        <a:Messages>
          <a:APIMessage>
            <a:Message>Duration of call was 0,0421337 sec.</a:Message>
            <a:Severity>Message</a:Severity>
            <a:ErrorCode>0</a:ErrorCode>
          </a:APIMessage>
        </a:Messages>
        <a:ErrorCode>0</a:ErrorCode>
        <a:IsReturnPaged>false</a:IsReturnPaged>
        <a:TotalPageCount>0</a:TotalPageCount>
      </GetProjectByIDResult>
    </GetProjectByIDResponse>
  </s:Body>
</s:Envelope>

Illustrative example: built from the service description (WSDL) in the same format as a real response, with made-up values. The Request block is shortened.

Errors

All errors come back with HTTP 200: check ResponseState, ErrorCode and Messages. The errors every operation can return (expired or invalid token, API not enabled, HTTPS required, general errors) are listed once in Responses and errors.

This operation has no errors of its own beyond the shared ones.

Was this page helpful?