Users and organisationGet a legal entity

Get a legal entity

Returns one legal entity by its integer LegalEntityID.

Returns the legal entity with its currency and default country. An unknown ID does NOT fail: it returns 200 with an empty object. Treat LegalEntityID 0 in the response as "not found".

Use it to:

  • Resolve User.LegalEntityID to the company name and currency

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Changes are visible to the next read immediately.

Call first: GET /v1/legal-entity

See also: GET /v1/legal-entity/system

curl -X GET "https://app3.timelog.com/your-account/api/v1/legal-entity/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "LegalEntityID": 0,
    "Name": null,
    "IsActive": false,
    "ID": "00000000-0000-0000-0000-000000000000",
    "CurrencyID": 0,
    "CurrencyISO": null,
    "CountryISO": null,
    "IsSystemLegalEntity": false
  },
  "Links": [
    {
      "Href": "https://app{server-number}.timelog.com/{account}/api/v1/legal-entity/99999999",
      "Rel": "self"
    }
  ]
}
GET
/v1/legal-entity/{legalEntityId}
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
legalEntityIdinteger
Required

LegalEntityID. The route has no {int} constraint; a non-integer gets 400.

Format: int32
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

legalEntityIdinteger
Required

LegalEntityID. The route has no {int} constraint; a non-integer gets 400.

Responses

Propertiesobject

A legal entity is a company inside one TimeLog account (multi-company set-up, feature MultiLegalEntities). Every user, and therefore every employee, belongs to exactly one legal entity; hourly rates and cost prices are defined per legal entity, and the legal entity's currency is the currency its users' amounts are reported in. Every account has exactly one system (default) legal entity, also when MultiLegalEntities is off.

Not yet documented: description.

Linksarray
Actionsobject[]