Get a user's allocation on a task
Returns one user's allocation on one task — allocated and registered hours and the hourly rate it uses — or 204 when there is none.
Looks up the allocation of userId's employee on taskId. Found → 200 with a single EmployeeAllocationOnTaskRead: AllocationId, allocated hours, all hours registered on it (all dates), and the allocation's contract hourly rate (ID, name, amount) with the currency abbreviation of the PATH project. No allocation — or an allocation whose rate row is missing — answers 204 with no body.
Use it to:
- Show whether a person is already on a task and at which rate before re-planning
Not for:
- All allocations of a task →
GET /v1/task/{taskID}/allocation
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Call first: GET /v1/user, GET /v1/task
Next: PUT /v1/allocation/{allocationID}
See also: GET /v1/allocation/{allocationID}, GET /v2/projects/{projectId}/employee-unallocated
Not yet documented: examples.
curl -X GET "https://app3.timelog.com/your-account/api/v2/projects/123/employee-allocation?taskId=123&userId=123" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v2/projects/123/employee-allocation?taskId=123&userId=123"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://app3.timelog.com/your-account/api/v2/projects/123/employee-allocation?taskId=123&userId=123", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://app3.timelog.com/your-account/api/v2/projects/123/employee-allocation?taskId=123&userId=123", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app3.timelog.com/your-account/api/v2/projects/123/employee-allocation?taskId=123&userId=123')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"Properties": {
"UserId": 123,
"AllocationId": 123,
"AllocatedHours": 3.14,
"RegisteredHours": 3.14,
"HourlyRateId": 123,
"HourlyRateName": "null",
"HourlyRateAmount": 3.14,
"HourlyRateCurrencyAbb": "example_string"
},
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
],
"Actions": [
{}
]
}
{}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v2/projects/{projectId}/employee-allocationTarget server for requests. Edit to use your own host.
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.
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.Project whose currency abbreviation is returned; only read when an allocation exists. Not checked against taskId.
The task. Omitted → 404 (captured).
The user. Unknown → 500.
Request Preview
Response
Response will appear here after sending the request
Authentication
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
Project whose currency abbreviation is returned; only read when an allocation exists. Not checked against taskId.
Query Parameters
The task. Omitted → 404 (captured).
The user. Unknown → 500.
Responses
One user's allocation on one task: the allocated hours, the hours registered on it so far, and the contract hourly rate it uses (name, amount, currency label).