Skip to main content
GET
Error

Authorizations

donate-api-key
string
header
required

Developer API key. Required for config create/list and project analytics. The disabled config DELETE endpoint also requires authentication. Optional on public GET reads (anonymous callers are IP rate-limited). Obtain from the Developer dashboard.

Path Parameters

type
enum<string>
required
Available options:
charity,
campaign
id
string
required

Response

OK

id
string
required
name
string
required

Public image URL, or the Donate placeholder when no image is available.

type
any
required
description
string
required

Plain-text description with HTML markup removed.

url
string
required
eligible
boolean
required

Whether this beneficiary can be selected for a new config.