Filtering and pagination

Commands that list a collection accept the same filtering, ordering, and paging flags. The expressions are the platform’s, not the CLI’s: --filter and --order-by are passed to the API verbatim, so what you can write is exactly what Filtering documents.

Filtering and ordering

qibdo taxonomy workspaces list --filter 'state = "ACTIVE"'

Quote the expression so the shell leaves it alone. Single quotes on the outside and double quotes around string values is the combination that survives every shell without escaping.

--order-by takes an ordering expression the same way. Filterable and sortable fields are curated per resource and are not the same set, so check the resource’s reference page rather than assuming a field supports both.

Pagination is transparent

By default, listing a collection lists all of it. The CLI fetches every page and renders the whole result, so you do not have to loop over page tokens to answer a simple question.

Three flags shape that:

• --limit caps the total number of items the CLI will return, across as many pages as it takes to reach the cap. This is the flag you want for “just show me a few”.
• --page-size sets how many items each request asks for. It shapes the requests, not the result: the CLI still walks every page.
• --page-token selects one page manually, for a script driving pagination itself.

qibdo taxonomy workspaces list --limit 20

Only --page-token turns the transparent behaviour off: the CLI returns exactly one page and prints the next page’s token on stderr, so a script can capture it and resume. To bound how much a command returns, reach for --limit, not --page-size.

--skip applies a server-side offset, and it applies to the first page only.

Bounding a projection

--query buffers the whole result before projecting it, so on a large collection pair it with --limit:

qibdo taxonomy workspaces list --query '[].name' -o tsv --limit 100

Related

• Filtering for the expression grammar, operators, and functions
• Output and scripting