Skip to content

Retrieve a feedback item

Request

Retrieve a feedback item.

Requires project.feedback.read permission.

Security
ApiKey
Path
orgIdstring^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$required
Organization ID.
Example:org_01h1s5z6vf2mm1mz3hevnn9va7
projectIdstring^prj_[0-9abcdefghjkmnpqrstvwxyz]{26}$required
Project ID.
Example:prj_01hh1t9sa6gwfv5naz04gr7ehm
feedbackIdstring^fb_[0-9abcdefghjkmnpqrstvwxyz]{26}$required
Feedback ID.
Example:fb_01h1s5z6vf2mm1mz3hevnn9va7
Headers
x-redocly-clientstring^[a-z0-9-]{1,64}/[\w.+-]{1,32}$

Identifies the calling client as <name>/<version>, for example reunite-ui/0.92.1. Used for API consumer observability. Requests without it are attributed as unknown.

Example:reunite-ui/0.92.1
curl -i -X GET \
  https://redocly.com/_mock/docs/platform/customization/reunite-api/openapi/orgs/org_01h1s5z6vf2mm1mz3hevnn9va7/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/feedback/fb_01h1s5z6vf2mm1mz3hevnn9va7 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-client: reunite-ui/0.92.1'

Responses

OK.
Bodyapplication/json
idstring^fb_[0-9abcdefghjkmnpqrstvwxyz]{26}$read-onlyrequired

Feedback ID. Unique identifier prefixed with fb_.

Example:"fb_01h1s5z6vf2mm1mz3hevnn9va7"
objectstringread-onlyrequired
Entity name.
Value:"feedback"
uristring, (uri)read-onlyrequired
Canonical URI for the feedback resource.
Example:"https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/feedback/fb_01h1s5z6vf2mm1mz3hevnn9va7"
emailstring or null, (email), <= 254 characters

Email address of user who submitted the feedback or null.

pathstring, [ 1 .. 1000 ] charactersrequired

Absolute URL of the page where feedback is submitted (for example from the browser location). A value that is not a valid URL is accepted, but the feedback is marked as spam.

Example:"https://example.com/docs/guide"
locationstring or null, <= 5000 characters
Identifies the location of the component. This could be a code sample.
langstring, <= 20 characters

Identifies the language of the component's location. This could be the language of a code sample, such as js, php, or txt.

feedbackComponentstringrequired
Name that identifies UI component.
Enum:"SENTIMENT""RATING""COMMENT""MOOD""PROBLEM""SCALE"
scoreinteger or null, [ -1 .. 10 ]

Numeric value that maps to the feedback component, such as thumbs down (-1) or thumbs up (1), or a 1-5 star rating scale.

maxScoreinteger or null, [ 0 .. 10 ]
Maximum score for the feedback component.
reasonsArray of strings
List of preset reasons for feedback.
commentstring, <= 5000 characters
Free-form text feedback.
agentstring or null, <= 200 characters

Name of the AI agent that submitted the feedback, or null for user-submitted feedback.

Example:"Cursor"
targetFeaturestring or null, <= 500 characters

Documentation feature the feedback refers to (for agent submissions), or null for user-submitted feedback.

Example:"Respect Monitoring API"
originstringrequired

Origin of the feedback. FORM is the feedback form on the page, API is a direct API call (for example an agent that follows llms.txt instructions), and MCP is the MCP server submit-feedback tool. When omitted on create, defaults to API if agent is set and to FORM otherwise.

Enum:"FORM""API""MCP"
Example:"MCP"
metadataobject

Extra tracking fields. The server sets userAgent, ipAddress, platform, and email (read-only). id, firstName, lastName, and auth_time pass through if present but are not verified; do not use for access or identity. Any other key is stored with its value redacted to a placeholder.

createdAtstring, (date-time)read-onlyrequired
statusstringread-onlyrequired
Feedback status.
Enum:"NEW""IN_REVIEW""RESOLVED""ARCHIVED""SPAM"
Example:"ARCHIVED"
organizationIdstring^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$read-onlyrequired

Organization ID. Unique identifier prefixed with org_.

Example:"org_01hh1t9sa6gwfv5naz04gr7ehm"
projectIdstring^prj_[0-9abcdefghjkmnpqrstvwxyz]{26}$read-onlyrequired

Project ID. Unique identifier prefixed with prj_.

Example:"prj_01hh1t9sa6gwfv5naz04gr7ehm"
internalCommentstring or nullread-only
Internal comment for the feedback.
Example:"This feedback is related to the issue 235."
internalCommentUpdatedAtstring, (date-time)read-only
Date and time when the internal comment is updated.
internalCommentUpdatedByIdstringread-only
ID of the user who updated the internal comment.
Response
{
  "id": "fb_01h1s5z6vf2mm1mz3hevnn9va7",
  "object": "feedback",
  "uri": "https://app.cloud.redocly.com/api/orgs/org_01hh1t9sa6gwfv5naz04gr7ehm/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/feedback/fb_01h1s5z6vf2mm1mz3hevnn9va7",
  "email": "user@example.com",
  "path": "https://example.com/docs/guide",
  "location": "string",
  "lang": "string",
  "feedbackComponent": "SENTIMENT",
  "score": -1,
  "maxScore": 0,
  "reasons": [
    "string"
  ],
  "comment": "string",
  "agent": "Cursor",
  "targetFeature": "Respect Monitoring API",
  "origin": "MCP",
  "metadata": {
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
    "ipAddress": "127.0.0.1",
    "platform": "Windows NT 10.0; Win64; x64",
    "email": "john.doe@acme.com",
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "auth_time": 0
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "status": "ARCHIVED",
  "organizationId": "org_01hh1t9sa6gwfv5naz04gr7ehm",
  "projectId": "prj_01hh1t9sa6gwfv5naz04gr7ehm",
  "internalComment": "This feedback is related to the issue 235.",
  "internalCommentUpdatedAt": "2019-08-24T14:15:22Z",
  "internalCommentUpdatedById": "string"
}