ConventionsRate limits and known limitations

Rate limits and known limitations

What this REST API documentation does not cover yet — rate limits, environments, network requirements and every open item across the REST pages — so you can plan your integration around it.

Overview

This page lists what the REST API documentation does not cover yet, in one place. Use it to plan: if your integration depends on one of these items, design for it to be unknown and check back here.

Items marked Not yet documented have not been verified, so they are stated as open rather than guessed. When an item is documented, it moves to the page it belongs to and leaves the list below.

Rate limits

TimeLog has not published rate limits for the REST API. Usage is monitored, and TimeLog contacts the employee marked as TimeLog Responsible in the account before limiting its API use. See Usage and change policy.

There are no published request quotas, burst limits or rate-limit response headers to design against. Until there are, general HTTP practice keeps an integration well-behaved:

  • Back off if you receive 429 or 503. Wait before retrying, and increase the wait on each repeated failure. Do not retry in a tight loop.
  • Avoid tight polling. Read on a schedule that matches how fresh your data needs to be, not as fast as the API answers.
  • Retry writes only when they are safe to repeat. A retry after a timeout can create a duplicate. See Errors — When to retry and Writing data — Safe retries.

Environments and sandbox

Not yet documented. Whether a sandbox or test environment is available for REST API integrations, and how to get access to one, is not yet documented.

Network requirements

Not yet documented. Network requirements for calling the REST API, such as IP allowlisting, are not yet documented.

Not yet documented: index

Every open item across the REST API pages, with the page where it appears.

TopicWhere
Rate limitsThis page · Authentication
Sandbox and test environmentsThis page
Network requirements (IP allowlisting)This page
Choosing between the REST, Transactional and Reporting APIsOverview
Steps to create, name and revoke a personal access tokenAuthentication
Token lifetimeAuthentication
OAuth client flow for third-party applicationsAuthentication
Privilege requirements of operations not listedPermissions and data scope
Licence, module and feature requirements of operations not listedPermissions and data scope
Version served when the URL has no version segment (default version)Base URL and versioning
Recommended version and deprecation policyBase URL and versioning
How API changes are announcedBase URL and versioning
Full structure of an action objectResponse envelope
Paging property names of GET /v2/milestones/incompletePagination
Paging of GET /v1/contact and GET /v2/insights-service/hour-kpi-per-month-privilegePagination
Timezone of date and time values without an offsetData types
Monetary amounts and currencyData types
Enum names in request bodiesData types
Language of text in responses (localization)Data types
Concurrent-update detection (concurrency control)Writing data
Whether a Code 100 error is safe to retryErrors
Example of a successful create responseYour first time registration
Where to report a documentation problemThis page

Coverage of the reference

The API reference — v1 and API reference — v2 groups in the sidebar cover 338 operations: 226 in v1 and 112 in v2.

  • Not every operation is included yet. A small number of operations in TimeLog's API description are not yet included in this reference while their documentation is completed.
  • Response examples are shown only where a verified response was available. An operation without an example still documents its response model.
  • Some descriptions are shorter than others on purpose. Details that could not be verified were left out rather than guessed.

Report a documentation problem

Not yet documented. A contact for reporting documentation problems or asking questions about the REST API is not yet published.