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

register
enum<string>
required

Register id from GET /charity-requests/registers

Available options:
united-states,
england-wales,
scotland,
northern-ireland,
france,
japan,
new-zealand,
norway,
netherlands,
canada,
australia
registration
string
required

Registration number

Response

OK

register
enum<string>
required

Register id from GET /charity-requests/registers

Available options:
united-states,
england-wales,
scotland,
northern-ireland,
france,
japan,
new-zealand,
norway,
netherlands,
canada,
australia
registration
string
required

Canonical registration number

status
enum<string>
required
Available options:
listed,
requested,
needs_info,
reviewed,
not_requested
charity
object | null
required

The public charity, when this registration is listed on Donate.gg

queue
object | null
required

Present while the request is waiting for review