Get a contract hourly rate
Returns one contract hourly rate by its integer ID, including superseded (indexed) versions.
Reads a single rate row. Unlike the list, it also returns rows that were superseded by an indexation (re-pricing) — nothing in the response says the row is no longer current, so do not use this to read "the current price" of an ID you stored earlier: after an indexation the current rate has a NEW ContractHourlyRateID (find it with the list). An unknown ID is a 500, not a 404.
Use it to:
- Resolve the HourlyRateID of a task or allocation to its name, amount and currency
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Call first: GET /v1/contract-hourly-rate
Not yet documented: examples.
curl -X GET "https://app3.timelog.com/your-account/api/v1/contract-hourly-rate/get-by-id?contractHourlyRateID=123" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/contract-hourly-rate/get-by-id?contractHourlyRateID=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/v1/contract-hourly-rate/get-by-id?contractHourlyRateID=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/v1/contract-hourly-rate/get-by-id?contractHourlyRateID=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/v1/contract-hourly-rate/get-by-id?contractHourlyRateID=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": {
"ContractHourlyRateID": 123,
"ContractHourlyRateGUID": "123e4567-e89b-12d3-a456-426614174000",
"ProjectSubContractID": 123,
"Name": "John Doe",
"Amount": 3.14,
"Type": "Standard",
"ContractSpecificHourlyRateID": "null",
"IsActive": true,
"IsManuallyAdjusted": true,
"ProductNo": "null",
"CurrencyISO": "example_string"
},
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
],
"Actions": [
{}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"Message": "No HTTP resource was found that matches the request URI 'https://app{server-number}.timelog.com/{account}/api/v1/contract-hourly-rate/get-by-id'.",
"MessageDetail": "No action was found on the controller 'ContractHourlyRate' that matches the request."
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v1/contract-hourly-rate/get-by-id
Target 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.The rate's ContractHourlyRateID. Omitted → 404 action-not-matched (captured). Unknown → 500 Code 100.
Refers to ContractHourlyRateRead.ContractHourlyRateID. Look up valid values with GET /v1/contract-hourly-rate.
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.
Query Parameters
The rate's ContractHourlyRateID. Omitted → 404 action-not-matched (captured). Unknown → 500 Code 100.
Refers to ContractHourlyRateRead.ContractHourlyRateID. Look up valid values with GET /v1/contract-hourly-rate.
Responses
One hourly (sales) rate that a contract (ProjectSubContract) charges for time. A contract carries its own list of rates; tasks and allocations on the contract point at one of them, and registered hours are priced with it. A rate is a COPY: Standard and Customer rates are copied from the account's price list (standard or customer specific) when they are added to the contract, Project rates exist only on this contract. Changing a rate's amount ("indexation") does not edit the row — the old row is marked indexed and a new row with a new ContractHourlyRateID takes over; the list hides indexed rows, get-by-id still returns them.
Not yet documented: description.