Inspect a receipt email

GET

/org-admin/{slug}/donations/{id}/receipt-emails/{emailId}

Only receipt emails tied to this donation are available. Account tokens, unsubscribe capabilities and private anonymous greeting names are removed from the inspection view. Requires organization permission org.read_donations.

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)

Parameters

Path Parameters

slug*

Organization slug; middleware resolves and authorizes this organization before any read or write.

Type

string

Required

id*

Type

string

Required

Format

"uuid"

emailId*

Type

string

Required

Format

"uuid"

Responses

Successful organization-scoped response

Content-Type

application/json

{

"data": {

"id": "string",

"recipient_email": "string",

"subject": "string",

"status": "string",

"created_at": "string",

"sent_at": "string",

"html_body": "string",

"text_body": "string"

}

}

GET

/org-admin/{slug}/donations/{id}/receipt-emails/{emailId}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

slug*

id*

emailId*

Samples

Powered by VitePress OpenAPI