Skip to content

filter projects by tag API parameter #1222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 6, 2025
+5 −0
Merged

filter projects by tag API parameter #1222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d130d1d
filter projects by tag API parameter
brandonc Oct 31, 2025
9c750c3
Apply suggestion from @trujillo-adam
brandonc Nov 6, 2025
ef9c2c5
Merge branch 'main' into TF-31754-document-list-projects-api-tag-filt…
brandonc Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions content/terraform-docs-common/docs/cloud-docs/api-docs/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ description: >-

Keep track of changes to the API for HCP Terraform and Terraform Enterprise.

## 2025-10-31
* Document API filtering parameters when [`listing projects`](/terraform/cloud-docs/api-docs/projects)

<!-- BEGIN: TFC:only name:hcp-eu -->

## 2025-9-30
Expand Down
2 changes: 2 additions & 0 deletions content/terraform-docs-common/docs/cloud-docs/api-docs/projects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,8 @@ This endpoint supports pagination [with standard URL query parameters](/terrafor
| `filter[permissions][create-workspace]` | **Optional.** If present, returns a list of projects that the authenticated user can create workspaces in. |
| `filter[permissions][move-stack]` | **Optional.** If present, returns a list of projects that the authenticated user can move Stacks between. Only available in HCP Terraform. |
| `filter[permissions][update]` | **Optional.** If present, returns a list of projects that the authenticated user can update. |
| `filter[tagged][i][key]` | **Optional.** If specified, restricts results to projects that are tagged with the provided key. Use a value of `"0"` for `i` if you are only using a single filter. For multiple tag filters, use an incrementing integer value for each filter. HCP Terraform combines multiple tag filters with a logical `AND` when filtering results. |
| `filter[tagged][i][value]` | **Optional.** If specified, restricts results to projects that are tagged with the provided value. This is useful when combined with a `key` filter for more specificity. Use a value of `"0"` for `i` if you are only using a single filter. For multiple tag filters, use an incrementing integer value for each filter. HCP Terraform combines multiple tag filters with a logical `AND` when filtering results. |
| `sort` | **Optional.** Allows sorting the organization's projects by `"name"`. Prepending a hyphen to the sort parameter reverses the order. For example, `"-name"` sorts by name in reverse alphabetical order. If omitted, the default sort order is arbitrary but stable. |

### Sample Request
Expand Down
Loading