SettingsGet a car

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"
{
  "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"
    }
  ]
}
GET
/v1/car/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

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.

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
idstring
Required

CarRead.CarID (integer) or CarRead.ID (GUID). Refers to CarRead.CarID. Look up valid values with GET /v1/car.

query
$expandstring

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. |

Options: owner, mileagerate
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

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

idstring
Required

CarRead.CarID (integer) or CarRead.ID (GUID).

Refers to CarRead.CarID. Look up valid values with GET /v1/car.

Query Parameters

$expandstring

Optional expansions.

Several values: one string, separated by ,.

Allowed values:

ValueNameMeaning
ownerownerFill EmployeeUser (owner's user record, incl. e-mail) on a private car. Both variants.
mileageratemileagerateFill DefaultMileageRate.
Allowed values:ownermileagerate

Responses

Propertiesobject

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.

Linksarray
Actionsobject[]