[BUG] Error when using -q in API commands

[tarente]

Bug Description

If I execute the following command it works:

fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems -q text.value

If using a filter that has spaces it will fail:

fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems -q text.value[?displayName=="<Object name contains spaces>"]

x api: [InvalidInput] Invalid jmespath query (https://jmespath.org)

If using a filter that does not have spaces it will work:

fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems -q text.value[?type=="Notebook"]

{
  "status_code": 200,
  "text": {
    "value": [
      {
        "id": "24f913d0-xxxx-yyyy-zzzz-c55bee186754",
        "displayName": "<Object name contains spaces>",
        "description": "New notebook",
        "type": "Notebook",
        "workspaceId": "3f94c8f3-xxxx-yyyy-zzzz-53c632513149",
        "retentionExpirationDateTime": "2026-04-14T18:02:18.5278736",
        "parentItemId": null,
        "folderId": null
      }
    ]
  }
}

Shouldn't the following query only return the id? I.e., 24f913d0-xxxx-yyyy-zzzz-c55bee186754

fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems -q text.value[?type=="Notebook"].id

{
  "status_code": 200,
  "text": {
    "value": [
      {
        "id": "24f913d0-xxxx-yyyy-zzzz-c55bee186754",
        "displayName": "<Object name contains spaces>",
        "description": "New notebook",
        "type": "Notebook",
        "workspaceId": "3f94c8f3-xxxx-yyyy-zzzz-53c632513149",
        "retentionExpirationDateTime": "2026-04-14T18:02:18.5278736",
        "parentItemId": null,
        "folderId": null
      }
    ]
  }
}

The solution that I found is to do the filter in PowerShell like this

(fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems | ConvertFrom-Json).text.value | Where-Object { $_.displayName -eq "<Object name contains spaces>" } | Select-Object -ExpandProperty id

24f913d0-xxxx-yyyy-zzzz-c55bee186754

fabric-cli version

1.5.0

Python version

Python 3.13.12

Operating System

Windows

CLI Mode

Command line mode

Authentication Method

Interactive browser login

Steps to Reproduce

1. In a Fabric Workspace delete 2 Notebooks with spaces in their names.
2. fab auth logout
3. fab auth login
4. Update the Workspace ID in the commands described in the Bug Description.

Expected Behavior

fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems -q text.value[?displayName=="<Object name contains spaces>"]

Would filter for the object's displayName for the Object name containing spaces.

fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems -q text.value[?displayName=="<Object name contains spaces>"].id

Would filter for the object's displayName for the Object name containing spaces and return only the value for id.

Actual Behavior

See Bug Description.

Additional Context

No response

Possible Solution

No response

[github-actions]

AI Assessment: Potential Bug

The CLI's handling of JMESPath queries containing string literals with spaces appears to be incorrect or fragile. Per JMESPath syntax (https://jmespath.org) and expected CLI usage, a filter like [?displayName=="<Object name contains spaces>"] is valid and should not result in an "Invalid jmespath query" error. The report suggests the query parsing is either not properly quoting/escaping, or the CLI's argument handling is interfering (potentially by shell-escaping issues or by improper parsing of quoted strings on Windows).

Additionally, the result for the .id projection is not respected; the output still returns the full object instead of a list of ids. This points to an issue in how the CLI applies JMESPath expressions rather than a misconfiguration. Both behaviors deviate from documented query parameter handling: see https://microsoft.github.io/fabric-cli/essentials/parameters/ for intended JMESPath integration.

Team investigation is needed to verify if the CLI properly passes quoted JMESPath queries (especially on Windows), and if projection syntax after filtering works as documented.

Next Steps

🔔 Escalated to team — This issue requires team review and has been flagged for attention.

---

💡 If this issue requires the team's attention and was not escalated, you can tag @microsoft/fabric-cli-dev to notify the team.

[github-actions]

🔔 @microsoft/fabric-cli-dev — This issue has been flagged by AI triage as requiring team attention. Please review the assessment above.

[aviatco]

/triaged

[microsoft-github-policy-service]

Triage has been completed for this issue.

[aviatco]

@tarente Thank you for sharing this.
You should be able to query the results by filtering on names that include spaces, as well as by retrieving only the IDs.
The query you provided is slightly inaccurate. You need to wrap the JMESPath expression in double quotes (") and the filter itself in single quotes ('), as shown below:

fab api -A fabric -X get workspaces/3f94c8f3-xxxx-yyyy-zzzz-53c632513149/recoverableItems -q "text.value[?displayName=='<Object name contains spaces>'].id"

Please refer to our documentation here.