GetTasksBySearchText

Project management service 1.8: Searches tasks of projects open for time registration by task, project or customer name / number and returns them with their parent tasks.


Service	Project management 1.8
Endpoint	`POST https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc`
SOAPAction	`GetTasksBySearchTextRequest`
Content-Type	`text/xml; charset=utf-8`
Authentication	A token from GetToken
Permissions	Time-registration privilege 'all tasks'; without it: 30024. With it: every matching task of every project open for time registration, budgets and default rate included.
Changes data	No
Safe to retry	Yes

How it works

The time-tracker search. Requires the caller to have the time-registration privilege 'all tasks'. A text of fewer than 2 characters returns nothing. No task-status or active filter is applied. Not paged.

Parameters

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

critiriastring

Required

Search text. Fewer than 2 characters returns nothing.

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: "GetTasksBySearchTextRequest"

<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:GetTasksBySearchText>
      <pm:critiria>{critiria}</pm:critiria>
      <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:GetTasksBySearchText>
  </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: "GetTasksBySearchTextRequest"' \
  --data-binary @request.xml

import requests

URL = "https://app{server-number}.timelog.com/{account}/WebServices/ProjectManagement/V1_8/ProjectManagementServiceSecure.svc"
SOAP_ACTION = '"GetTasksBySearchTextRequest"'

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:GetTasksBySearchText>
      <pm:critiria>{critiria}</pm:critiria>
      <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:GetTasksBySearchText>
  </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.

ReturnTask[]

Response<Task>: the matching tasks and their parent tasks. Not paged; at most N matches plus their parents. Success with an empty Return.

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>
    <GetTasksBySearchTextResponse xmlns="http://www.timelog.com/api/tlp/v1_8">
      <GetTasksBySearchTextResult xmlns:a="http://api.timelog.com"
                                  xmlns:b="http://www.timelog.com/api/tlp/v1_7"
                                  xmlns:c="http://api.timelog.com/services/crm/1_2"
                                  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Return>
          <b:Task>
            <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:TaskID>1001</b:TaskID>
            <b:Name>Example </b:Name>
            <b:FullName>Example full</b:FullName>
            <b:No>1001</b:No>
            <b:Description>Example</b:Description>
            <b:Link>Example</b:Link>
            <b:BudgetHours>0</b:BudgetHours>
            <b:BudgetAmount>0</b:BudgetAmount>
            <b:StartDate>2026-10-01T00:00:00</b:StartDate>
            <b:EndDate>2026-10-01T00:00:00</b:EndDate>
            <b:TaskTypeID>1001</b:TaskTypeID>
            <b:AdditionalTextIsRequired>false</b:AdditionalTextIsRequired>
            <b:ProjectSubContractID>1001</b:ProjectSubContractID>
            <b:HourlyRateID>1001</b:HourlyRateID>
            <b:IsReadyForInvoicing>false</b:IsReadyForInvoicing>
            <b:Details>
              <b:CustomerHeader>
                <c:ID>1001</c:ID>
                <c:Name>Example </c:Name>
                <c:No>1001</c:No>
                <c:GUID>3f2504e0-4f89-41d3-9a0c-305000000002</c:GUID>
              </b:CustomerHeader>
              <b:ProjectHeader>
                <b:ID>1001</b:ID>
                <b:ProjectGUID>3f2504e0-4f89-41d3-9a0c-305000000003</b:ProjectGUID>
                <b:Name>Example </b:Name>
                <b:No>1001</b:No>
                <b:IsActive>true</b:IsActive>
                <b:IsGeneralProject>false</b:IsGeneralProject>
                <b:StartDate>2026-10-01T00:00:00</b:StartDate>
                <b:EndDate>2026-10-01T00:00:00</b:EndDate>
                <b:MainContractID>1001</b:MainContractID>
              </b:ProjectHeader>
              <b:Type>
                <b:ID>1001</b:ID>
                <b:ID2>0</b:ID2>
                <b:Name>Example </b:Name>
                <b:Name2>Example</b:Name2>
              </b:Type>
              <b:CustomField>Example</b:CustomField>
            </b:Details>
            <b:State>
              <b:IsActive>true</b:IsActive>
            </b:State>
          </b:Task>
        </a:Return>
        <a:ReturnTypeDescription>Task</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>
      </GetTasksBySearchTextResult>
    </GetTasksBySearchTextResponse>
  </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.

Errors specific to this operation:

ResponseState	ErrorCode	Message	What it means	What to do
Invalid	30024	Timelog is not configured to the action: GetTasksBySearchText. Check the system setting: Allow Timetracking on All projects	Return empty.	—
Invalid	40004	V1_{n} is deprecated. Please upgrade to V1_{m} or later.	Nothing is read or written and the token is NOT checked.	Call the same operation on the current version.

Was this page helpful?