Skip to main content
GET
Get a Project
The response covers the project’s code, its availability flags, its metadataFields, and its totals: raisedAmount, donorAmount, giftAmount, averageGiftAmount, firstGiftDate, and lastGiftDate.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

projectId
integer<int64>
required

The ID of the project.

Response

OK

Represents a project model.

id
integer<int64>

The unique identifier of the project.

code
string | null

The code of the project.

isActive
boolean

Whether the project is active.

isAvailableOnline
boolean

Whether donors can give to the project online.

isPublic
boolean

Whether the project is shown publicly.

isDeleted
boolean

Whether the project has been deleted.

name
string | null

The name of the project.

description
string | null

The description of the project.

sortOrder
integer<int32>

The position of the project in the order it is displayed in.

emailAddresses
string | null

The email addresses notified when a gift is designated to the project.

metadataFields
object[] | null

Additional name and value pairs stored on the project.

image
string | null

The URL of the image shown for the project.

isPinned
boolean

Whether the project is pinned to the top of the list donors choose from.

donorAmount
integer<int32>

The number of donors who have given to the project.

giftAmount
integer<int32>

The number of gifts designated to the project.

createdDateTime
string | null

The UTC date and time the project was created.

modifiedDateTime
string | null

The UTC date and time the project was last modified.

raisedAmount
string | null

The total amount raised by the project.

averageGiftAmount
string | null

The average gift amount for the project.

firstGiftDate
string | null

The date of the first gift designated to the project.

lastGiftDate
string | null

The date of the most recent gift designated to the project.

isSystem
boolean

Whether the project is a built-in project Raise maintains.

percentageRecurringGift
number<double>

The share of the amount raised that came from recurring gifts.

externalIdentifier
string | null

An identifier of your own to store on the project, for reconciling it with an external system.

impactData
string | null

The text describing what a gift to the project accomplishes.

Last modified on July 28, 2026