Document status filter on GET /v1/users#53
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Jira
LA-36813
What
Documents the new
filters[status]query param onGET /v1/users, shipped by code PR learnamp/learnamp#23668 (merged). The endpoint reference was missing it.Adds one row to the "Optional Filters in URL Params" table:
filters[team_ids]).APIServices::Filters::Users::VALID_STATUSESand the Grape param):not_invited,invite_scheduled,invite_pending,confirmed,deactivated.Why
Docs-accuracy: the live endpoint accepts the filter, but the reference didn't list it.
Note
Low Risk
Documentation-only change in
_users.md; no runtime or API behavior is modified.Overview
Documents
filters[status]onGET /v1/users, aligning the reference with behavior already shipped in the API.The new table row describes filtering users who match any of the supplied statuses, using either an array or comma-separated values (same pattern as
filters[team_ids]). Allowed values arenot_invited,invite_scheduled,invite_pending,confirmed, anddeactivated.Reviewed by Cursor Bugbot for commit 798d673. Bugbot is set up for automated code reviews on this repo. Configure here.