> For the complete documentation index, see [llms.txt](https://docs.kick.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kick.co/ai/developer-tools/cli/cli-example-workflows.md).

# Additional Workflows

Copy Kick CLI commands for client lookup, transaction review, reporting, activity inspection, and JSON exports.

These examples are starting points. Replace workspace IDs, entity IDs, dates, and filters with the client context you are reviewing.

### Find the right client context

```
kick workspaces list
kick --workspace <workspace-id> whoami
```

Use this when you are switching between clients or checking whether a token is workspace-bound.

### Review transactions that need attention

```
kick --workspace <workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --limit 25
kick --workspace <workspace-id> transactions find --since 2026-01-01 --until 2026-01-31 --fields id,date,amount,counterparty,bank_description --output json
```

Use `--fields` to keep output focused when another tool or agent needs to read the result.

### Pull reports for review

```
kick reports profit-loss --entity 123 --start-date 2026-01-01 --end-date 2026-01-31 --basis cash --cycle month
kick reports balance-sheet --entity 123 --start-date 2026-01-01 --end-date 2026-01-31 --basis cash --output json
kick reports trial-balance --entity 123 --start-date 2026-01-01 --end-date 2026-01-31 --basis cash --output json
```

Use JSON output when another tool or script needs to read the result.

### Inspect activity before changing anything

```
kick --workspace <workspace-id> activity list --resource-type transaction --changed-fields categoryId --limit 10
kick --workspace <workspace-id> activity logs --resource-type transaction --limit 10 --output json
```

For deeper review:

```
kick --workspace <workspace-id> activity details --date 2026-04-01T00:00:00.000Z --source-type transaction_bulk_update --grouped --output json
```

### Pipe output to another tool

The CLI writes data to stdout and diagnostics to stderr, so stdout can be piped safely:

```
kick --workspace <workspace-id> transactions find --limit 10 --output json | jq '.[0].id'
```

For agent workflows, prefer compact structured output:

```
kick --workspace <workspace-id> transactions find --limit 25 --output json-compact
```

### Preview supported write actions

Preview-first commands return a confirmation token. Review the preview, then pass the token or use the documented confirmation flag only when you are ready.

Do not automate confirmation unless the workflow has been reviewed and approved by your firm.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.kick.co/ai/developer-tools/cli/cli-example-workflows.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
