Kimai icon

Kimai

Interact with Kimai time-tracking API

Customer → Get All

AI-generated

Summary

Retrieve a list of Kimai customers, optionally filtered by search term and visibility, and sorted by a chosen field and direction.

Inputs

  • visible — Filter customers by visibility: 1=Visible, 2=Hidden, 3=Both.
  • order — Sorting direction: ASC for ascending, DESC for descending.
  • orderBy — Field to sort by, such as ID or Name.
  • term — Search term to filter customers by name or other text fields.
  • requestOptions — Additional HTTP settings including batching, SSL verification, proxy, and timeout.

Output shape

an array of Customer objects

The response contains the full customer records; pagination is not exposed via these input fields.

Examples

Example 1: Get all visible customers ordered by name ascending

visible=1 order=ASC orderBy=name term=

Example 2: Search customers containing 'Acme' and return hidden ones as well

visible=3 term=Acme

Example 3: Fetch customers with batching of 100 items and a 500ms interval

visible=1 order=ASC orderBy=id term= requestOptions={"batching":{"batchSize":100,"batchInterval":500}}

Discussion