Read one feedback report

Written and maintained by The ProspectAPIs team

GET/v1/feedback/:id

GET /v1/feedback/:id is the ProspectAPIs operation getFeedback, in the Account group of the REST API. One report this account sent, with its status and the team's response. A report another account sent answers 404, the same as an id that does not exist. Free. Cost: free. Send your API key as a Bearer token in the Authorization header.

The quickstart shows this call in context, next to the first requests most integrations make.

Parameters

Parameters of GET /v1/feedback/:id
Name	In	Type	Description
id required	path	string (uuid)	A UUID.

Responses

Response codes of GET /v1/feedback/:id
Status	Meaning
200	The report.
401	The API key is missing or invalid.
404	No such record for this account.
429	Too many requests; retry after the window.

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

The report. The body is a Feedback.

Fields of the 200 response
Field	Type	Description
id required	string (uuid)	The feedback_id POST /v1/feedback returned.
kind required	string: bug, feature, question
tool required	string or null	The tool or endpoint the report is about, when one was named.
title required	string
details required	string
status required	string: received, triaged, fixed, wont_fix, needs_info	received: not looked at yet. triaged: the team is on it. fixed: shipped. wont_fix: not planned (the response says why). needs_info: the team needs more from you (see response).
response required	string or null	The team's reply, when there is one.
responded_at required	string (date-time) or null
created_at required	string (date-time)
updated_at required	string (date-time)	The last change to status or response.
from_this_key required	boolean	true when the API key making this call sent the report; another key of the same account reads it too.

Response headers
Header	Meaning
RateLimit-Limit	Requests this API key may make per minute.
RateLimit-Remaining	Requests left in the current one-minute window.
RateLimit-Reset	Seconds until the current window resets.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl

curl https://api.prospectapis.com/v1/feedback/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13 \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

JavaScript (fetch)

const res = await fetch("https://api.prospectapis.com/v1/feedback/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13", {
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

Python (requests)

import os, requests

res = requests.get(
    "https://api.prospectapis.com/v1/feedback/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

This call is free: it never spends credits, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.

Previous operation: Send feedback. Next operation: API version. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values.

Was this page helpful?