Funds

The Fundraise API allows to manage comprehensive fundraising activities by handling funds (base entity for collecting money), campaigns (targeted fundraising initiatives tied to specific funds), pledges (promises for future donations), and actual donations. Create and track multiple fundraising campaigns simultaneously, each connected to one or more funds, while managing incoming donations and pledges.

Endpoints

The Fund object

The FundResource serves as the foundational entity in fundraising, allowing to create named fundraising buckets with optional financial targets and deadlines. Each fund can track its progress towards a specific monetary goal by a target date, while the optional externalId enables seamless integration with external systems or third-party fundraising platforms.

Attributes

_id

Required

string

The ID of the Fund

name

Required

string

The name of the fund

sellerId

Required

string

The ID of the seller owning the fund

createdAt

Required

string date-time

An ISO timestamp indicating when the fund was created.

updatedAt

Required

string date-time

An ISO timestamp indicating when the fund was created.

Optional Attributes

Collapse all

target

Optional

object

The target (goal) amount and date of the fund

Optional Attributes

Collapse all

target.amount

Optional

number

The target amount of the fund

target.date

Optional

string date-time

An ISO timestamp indicating when the fund is planned to reach the goal (amount).

externalId

Optional

string

The external ID of the fund

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create a Fund

Payload

name

Required

string

The name of the fund

Optional Attributes

Collapse all

target

Optional

object

The target (goal) amount and date of the fund

Optional Attributes

Collapse all

target.amount

Optional

number

The target amount of the fund

target.date

Optional

string date-time

An ISO timestamp indicating when the fund is planned to reach the goal (amount).

externalId

Optional

string

The external ID of the fund

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string"
}

{
  "_id": "string",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update a Fund

Parameter

Required

The ID or external ID of the fund to retrieve. In case of external ID, the external ID must be prefixed with 'externalId:'.

Payload

Optional Attributes

Collapse all

name

Optional

string

The name of the fund

target

Optional

object

The target (goal) amount and date of the fund

Optional Attributes

Collapse all

target.amount

Optional

number

The target amount of the fund

target.date

Optional

string date-time

An ISO timestamp indicating when the fund is planned to reach the goal (amount).

externalId

Optional

string

The external ID of the fund

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string"
}

{
  "_id": "string",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get a Fund

Parameter

Required

The ID or external ID of the fund to retrieve. In case of external ID, the external ID must be prefixed with 'externalId:'.

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get All Funds

Query

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

_id

Optional

string

The ID of the fund to search for

name

Optional

string

The name of the fund to search for

externalId

Optional

string

The external ID of the fund to search for

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "name": "string",
      "target": {
        "amount": 1,
        "date": "2030-01-23T23:00:00.123Z"
      },
      "externalId": "string",
      "sellerId": "string",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}