Skip to content

List comments for a fundraiser​

GET
/fundraisers/{fundraiserId}/comments

Returns paginated comments for a fundraiser, newest first. Hidden and retracted comments are left out. A comment written as a donor's note from their receipt carries its gift (donation_amount_cents, donation_currency); on an anonymous gift the author fields are null and is_anonymous is true. Every row carries gif, a GIF object or null; a GIF comment's content may be empty.
Authentication is optional. Every row carries like_count; for a signed-in caller liked_by_me says whether they like it, and for a guest it is always false.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)
or

Parameters​

Path Parameters

fundraiserId*
Type
string
Required
Format
"uuid"

Query Parameters

limit
Type
integer
Default
50
Minimum
1
Maximum
100
offset
Type
integer
Default
0
Minimum
0

Responses​

Comment list

application/json
JSON
{
"data": [
{
"id": "string",
"fundraiser_id": "string",
"content": "string",
"gif": {
"id": "xT4uQulxzV39haRFjG",
"title": "string",
"width": 480,
"height": 270,
"mp4_url": "https://media2.giphy.com/media/xT4uQulxzV39haRFjG/giphy.mp4",
"webp_url": "https://media2.giphy.com/media/xT4uQulxzV39haRFjG/giphy.webp",
"gif_url": "https://media2.giphy.com/media/xT4uQulxzV39haRFjG/giphy.gif",
"still_url": "https://media2.giphy.com/media/xT4uQulxzV39haRFjG/giphy_s.gif",
"preview_mp4_url": "https://media2.giphy.com/media/xT4uQulxzV39haRFjG/200w.mp4",
"preview_webp_url": "https://media2.giphy.com/media/xT4uQulxzV39haRFjG/200w.webp",
"preview_width": 200,
"preview_height": 113
},
"parent_comment_id": "string",
"created_at": "string",
"updated_at": "string",
"author_id": "string",
"author_name": "string",
"author_avatar": "string",
"is_anonymous": true,
"donation_amount_cents": 0,
"donation_currency": "string",
"like_count": 0,
"liked_by_me": true
}
],
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress