Skip to content

List site feedback for admins ​

This Feedback operation is available through GET /product/sites/{siteId}/feedback. Use the reference below to inspect its request contract and documented responses before connecting it to your application.

Request preparation ​

Send a GET request to /product/sites/{siteId}/feedback on the appropriate server. Check the API overview for base URL guidance and the server information in the interactive reference. Replace path placeholders with identifiers from the intended account or site; a similarly named record in another workspace is not interchangeable.

The declared request parameters are:

  • siteId (path, required): Use the type and constraints shown in the parameter reference.
  • status (query, optional): Filters feedback by workflow status. Omit to include all statuses.
  • approval_status (query, optional): Optional approval filter. When supplied with status, both filters are applied.
  • visibility (query, optional): Use the type and constraints shown in the parameter reference.
  • assigned_user (query, optional): Team user ID, or none for feedback with no assignee.
  • roadmap_list (query, optional): Roadmap list ID, none for no roadmap, or any for feedback on a roadmap.
  • tag (query, optional): Exact tag. Filters are combined with AND.
  • q (query, optional): Search title, description, public author, and tags within the active filters.
  • feedback_id (query, optional): Restrict results to one feedback record for live item reconciliation.
  • include_filter_options (query, optional): Include tenant-scoped assignees and site-scoped roadmap lists and tags, independent of active feedback filters and result limits.
  • limit (query, optional): Use the type and constraints shown in the parameter reference.

No request body is declared in the current specification. Check the route and any documented parameters before sending the request rather than adding an arbitrary JSON payload.

Authentication and scope ​

The specification lists these security alternatives: BearerAuth, AccessToken. Read any operation-specific restrictions as well: browser-session, account-role, and signed-user requirements may impose additional conditions. See authentication before choosing a credential.

Keep credentials in the appropriate private configuration and remove secrets from shared logs. Confirm the target resource belongs to the intended workflow before issuing a request. Authentication alone should not be treated as confirmation that a supplied account, site, or customer identifier is correct.

Response handling ​

The documented responses for List site feedback for admins are:

  • 200: OK

Begin with a known record or a narrow query and inspect the returned fields before displaying them to users. Where the operation defines pagination, follow those parameters to retrieve additional results. An empty successful response is different from a failed request; keep errors visible to the calling workflow instead of presenting them as an empty data set.

If a connection fails after submission, investigate the current server state before repeating an action whose outcome is uncertain. When requesting support, retain the method, route, response status, and sanitized error message. The interactive reference below provides the detailed schemas and examples for this specific operation.

List site feedback for admins​

GET
/product/sites/{siteId}/feedback

Authorizations​

BearerAuth

JWT token from login

Type
HTTP (bearer)
or
AccessToken

Personal access token. Value: Token <your-token>

Type
API Key (header: Authorization)

Parameters​

Path Parameters

siteId*
Type
string
Required

Query Parameters

status

Filters feedback by workflow status. Omit to include all statuses.

Type
string
Valid values
"open""under_review""planned""in_progress""released""closed"
approval_status

Optional approval filter. When supplied with status, both filters are applied.

Type
string
Valid values
"pending""approved""rejected"
visibility
Type
string
Valid values
"public""private"
assigned_user

Team user ID, or none for feedback with no assignee.

Type
string
roadmap_list

Roadmap list ID, none for no roadmap, or any for feedback on a roadmap.

Type
string
tag

Exact tag. Filters are combined with AND.

Type
string
q

Search title, description, public author, and tags within the active filters.

Type
string
Max Length
300
feedback_id

Restrict results to one feedback record for live item reconciliation.

Type
string
include_filter_options

Include tenant-scoped assignees and site-scoped roadmap lists and tags, independent of active feedback filters and result limits.

Type
boolean
Default
false
limit
Type
integer
Default
100
Maximum
200

Responses​

OK

application/json
JSON
{
  
"items": [
  
],
  
"filter_options": "string",
  
"counts": {
  
  
"all": 0,
  
  
"approved": 0,
  
  
"pending": 0,
  
  
"rejected": 0
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI