Users and organisationGet the system legal entity

Get the system legal entity

Returns the account's system (default) legal entity.

Returns the legal entity flagged IsSystemLegalEntity — the account's main company. When the multi-company feature (MultiLegalEntities) is off this is the only legal entity users can be created in.

Use it to:

  • Get the LegalEntityID for user create on a single-company account
  • Read the account's base currency and country

Behaviour:

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

Next: POST /v1/user/create

See also: GET /v1/legal-entity, GET /v1/legal-entity/{legalEntityId}

Not yet documented: behaviour → consistency detail.

curl -X GET "https://app3.timelog.com/your-account/api/v1/legal-entity/system" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "LegalEntityID": 123,
    "Name": "John Doe",
    "IsActive": true,
    "ID": "123e4567-e89b-12d3-a456-426614174000",
    "CurrencyID": 123,
    "CurrencyISO": "example_string",
    "CountryISO": "USA",
    "IsSystemLegalEntity": true
  },
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ],
  "Actions": [
    {}
  ]
}
GET
/v1/legal-entity/system
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.
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.

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[]