Get a car
Returns one car by its integer CarID or its GUID — any car of the account, active or not, whoever owns it.
Resolves the CarID of a mileage registration (or a car GUID) to the car's name, plate, type, owner and default rate. IsDefault refers to the caller's own default car.
Use it to:
- Resolve MileageRegistrationRead.CarID for a mileage export
Not for:
- Discovering which cars the caller may use — use
GET /v1/car
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Call first: GET /v1/car
Next: PUT /v1/car
See also: GET /v1/mileage-registration/{mileageRegistrationID}
Not yet documented: transport → variants.
curl -X GET "https://app3.timelog.com/your-account/api/v1/car/example_string?$expand=owner" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/car/example_string?$expand=owner"
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/car/example_string?$expand=owner", {
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/car/example_string?$expand=owner", 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/car/example_string?$expand=owner')
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": {
"CarID": 1,
"Name": "Perodua Myvi ",
"LicensePlate": "YUSJ",
"CarType": 1,
"EmployeeUser": null,
"IsActive": true,
"ID": "e1fe59c5-ba8c-480b-88c1-3878a4ee4464",
"EmployeeUserID": null,
"DefaultMileageRate": null,
"IsDefault": false,
"AllowEmployeeChangeMileageRate": true
},
"Links": [
{
"Href": "https://app{server-number}.timelog.com/{account}/api/v1/car/1",
"Rel": "self"
}
]
}
{
"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
}
{
"Code": 100,
"Details": [],
"Message": "Unknown error occur in system, please contact system administrator.",
"Parameters": "carID: 99999999",
"Url": "https://app{server-number}.timelog.com/{account}/api/v1/car/99999999"
}
/v1/car/{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.CarRead.CarID (integer) or CarRead.ID (GUID).
Refers to CarRead.CarID. Look up valid values with GET /v1/car.
Optional expansions.
Several values: one string, separated by ,.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
| owner | owner | Fill EmployeeUser (owner's user record, incl. e-mail) on a private car. Both variants. |
| mileagerate | mileagerate | Fill DefaultMileageRate. |
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
CarRead.CarID (integer) or CarRead.ID (GUID).
Refers to CarRead.CarID. Look up valid values with GET /v1/car.
Query Parameters
Optional expansions.
Several values: one string, separated by ,.
Allowed values:
| Value | Name | Meaning |
|---|---|---|
owner | owner | Fill EmployeeUser (owner's user record, incl. e-mail) on a private car. Both variants. |
mileagerate | mileagerate | Fill DefaultMileageRate. |
ownermileagerateResponses
A car that mileage registrations are driven in. Two kinds exist (CarType): a COMPANY car (1) has no owner and can be picked by every employee of its legal entity; a PRIVATE car (2) belongs to exactly one employee (EmployeeUserID) and only that employee may register mileage with it. Each car belongs to one legal entity and carries a default mileage rate (the rate preselected on a mileage registration). The registration plate and the owner make a private car personal data.