Mark query parameters as required in 'Get Users of an Enterprise' API documentation

XMLWordPrintable

    • Type: Suggestion
    • Resolution: Unresolved
    • Component/s: Product - API
    • None
    • 1

      User Problem

      Trello's Get Users of an Enterprise endpoint (/1/enterprises/{id}/members/query) returns a 400 Bad Request error when requests are made without a search query parameter.

      The developer documentation currently lists all query parameters as optional and shows code examples that omit them. This leads developers to believe that the endpoint can be called without a search term, which causes confusion and unexpected API errors.

      https://developer.atlassian.com/cloud/trello/rest/api-group-enterprises/#api-enterprises-id-members-query-get

      Suggested Solutions

      • Update the API documentation to mark the query parameter as Required.
      • Update the code examples (cURL, Node.js, Python, Java, PHP) to include an example query parameter in the request URL.

      Current Workarounds

      • Include a search query parameter (e.g., ?query=example) when calling the endpoint.

              Assignee:
              Unassigned
              Reporter:
              Lam
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: