KimaiInstall

Summary

Retrieves all activities matching optional filters and sorting criteria.

Inputs

• project — Optional project ID or comma-separated list of project IDs to filter activities.
• projects — Comma-separated list of project IDs; overrides project if provided.
• visible — Visibility filter: 1=Visible, 2=Hidden, 3=All.
• globals — Whether to include global activities; boolean true (1) or false (0).
• orderBy — Field to order results by, e.g., id, name, or project.
• order — Sort direction, either ASC or DESC.
• term — Search term to filter activity names.
• requestOptions — Additional request configuration such as batching, timeout, proxy, and SSL options.

Output shape

An array of activity objects representing the retrieved activities.

Results are paginated; fields like id, name, project, visible, etc., are present. Optional pagination metadata may be included.

Examples

Example 1: Fetch all visible activities belonging to a specific project.

Set project to "12", visible to "1", and leave other fields at defaults.

Example 2: List all activities across projects, ordered by name ascending.

Set orderBy to "name", order to "ASC", and leave project empty.

Example 3: Search for activities containing the term "meeting" and return them globally.

Set term to "meeting", globals to true, and omit project and visible filters.