Skip to main content
GET
Read a fund

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The fund's record ID.

Response

The fund.

A FUND IS A RESTRICTION CHOSEN BY THE GIVER: what they said their money is for. Funds marked is_public appear on the organization's donation form, and a gift naming one is restricted to it. Not to be confused with an appeal, which is chosen by the organization; see Appeal.

id
string
name
string

What the giver reads on the donation form.

Maximum string length: 120
code
string | null

The organization's own reference. No two of their funds may share one.

Maximum string length: 40
description
string | null

One line under the name on the form: what the fund pays for.

sort_order
integer

The order funds are offered in. Lower first, then by name.

is_public
boolean

Whether it appears on the donation form. False for a fund that exists only for the books.

status
enum<string>

archived takes it off your donation form and out of the pickers, and leaves it on every gift that named it. Nothing here is deleted.

Available options:
active,
archived
raised_cents
integer

The total of completed gifts that name it, in whole cents. Pending, failed and refunded gifts do not count, and deleted ones are excluded.

donation_count
integer
donor_count
integer

How many different people gave them. A gift with no person on it counts towards raised_cents but not here.

created_at
string<date-time>
updated_at
string<date-time>