Get recommendations for the current user

curl --request GET \
  --url https://api.endaoment.org/v1/recommendations/for-me \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "collaboratorFund": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Doe Family Foundation",
      "type": "Private",
      "manager": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
      },
      "chainId": 1,
      "advisor": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "featuredIndex": 1,
      "usdcBalance": "20500000",
      "description": "A family foundation dedicated to supporting educational initiatives",
      "createdAtUtc": "2024-01-01T00:00:00Z",
      "updatedAtUtc": "2024-03-14T12:00:00Z",
      "lifetimeDonationsUsdc": "1000000000",
      "inboundFeeBps": 25,
      "outboundFeeBps": 50,
      "grantsGiven": 10,
      "inTransitBuyUsdcAmount": "5000000",
      "inTransitSellUsdcAmount": "3000000",
      "investedUsdc": "50000000",
      "totalGrantedUsdc": "25000000",
      "processingTransfersTotalUsdc": "1000000",
      "illiquidBalance": "10000000",
      "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
      "contractAddress": "0x1234567890123456789012345678901234567890",
      "lastBalanceSyncUtc": "2024-03-14T12:00:00Z",
      "shortDescription": "Supporting education",
      "vanityUrl": "doe-family-foundation",
      "paypalId": "123e4567-e89b-12d3-a456-426614174000",
      "logo": "https://example.com/logo.png",
      "staffNotes": "<string>",
      "category": "Education",
      "customFeeDetail": "Special Community Fund Agreement"
    },
    "collaborator": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "collaboratorUserId": "123e4567-e89b-12d3-a456-426614174000",
      "fundId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "Executed",
    "type": "grant"
  }
]

GET

recommendations

for-me

Get recommendations for the current user

curl --request GET \
  --url https://api.endaoment.org/v1/recommendations/for-me \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "collaboratorFund": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Doe Family Foundation",
      "type": "Private",
      "manager": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "walletAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
      },
      "chainId": 1,
      "advisor": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "featuredIndex": 1,
      "usdcBalance": "20500000",
      "description": "A family foundation dedicated to supporting educational initiatives",
      "createdAtUtc": "2024-01-01T00:00:00Z",
      "updatedAtUtc": "2024-03-14T12:00:00Z",
      "lifetimeDonationsUsdc": "1000000000",
      "inboundFeeBps": 25,
      "outboundFeeBps": 50,
      "grantsGiven": 10,
      "inTransitBuyUsdcAmount": "5000000",
      "inTransitSellUsdcAmount": "3000000",
      "investedUsdc": "50000000",
      "totalGrantedUsdc": "25000000",
      "processingTransfersTotalUsdc": "1000000",
      "illiquidBalance": "10000000",
      "deploymentTransactionHash": "0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567",
      "contractAddress": "0x1234567890123456789012345678901234567890",
      "lastBalanceSyncUtc": "2024-03-14T12:00:00Z",
      "shortDescription": "Supporting education",
      "vanityUrl": "doe-family-foundation",
      "paypalId": "123e4567-e89b-12d3-a456-426614174000",
      "logo": "https://example.com/logo.png",
      "staffNotes": "<string>",
      "category": "Education",
      "customFeeDetail": "Special Community Fund Agreement"
    },
    "collaborator": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "collaboratorUserId": "123e4567-e89b-12d3-a456-426614174000",
      "fundId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "Executed",
    "type": "grant"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

List of recommendations for the user successfully retrieved

string<uuid>

required

The unique identifier of the recommendation

collaboratorFund

object

required

The target fund of the recommendation

Show child attributes

collaboratorFund.id

string

required

Unique identifier of the fund

Example:

"123e4567-e89b-12d3-a456-426614174000"

collaboratorFund.name

string

required

Name of the fund

Example:

"Doe Family Foundation"

collaboratorFund.type

enum<string>

required

Access type of the fund

Available options:

Private,

Community,

Transparent,

ImpactPool

Example:

"Private"

collaboratorFund.manager

object

required

Basic information about the fund manager. The manager has technical capability to interact with the blockchain and perform programmatic functions.

Show child attributes

collaboratorFund.manager.id

string

required

Unique identifier of the fund manager

Example:

"123e4567-e89b-12d3-a456-426614174000"

collaboratorFund.manager.walletAddress

string

required

Ethereum wallet address of the fund manager

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

collaboratorFund.chainId

object

required

Chain ID where the fund is deployed

Example:

1

collaboratorFund.advisor

object

required

Fund advisor information. The advisor is tied to a real-world person/entity and acts as the public contact for the fund. This can be the same person as the manager or someone the manager acts on behalf of.

Show child attributes

collaboratorFund.advisor.firstName

string

required

First name of the fund advisor

Example:

"John"

collaboratorFund.advisor.lastName

string

required

Last name of the fund advisor

Example:

"Doe"

collaboratorFund.featuredIndex

number

required

Index determining the fund's position in featured listings. Lower numbers appear first

Example:

1

collaboratorFund.usdcBalance

string

required

Current USDC balance with 6 decimal places (1000000 = 1 USDC)

Example:

"20500000"

collaboratorFund.description

string

required

Detailed description of the fund

Example:

"A family foundation dedicated to supporting educational initiatives"

collaboratorFund.createdAtUtc

string

required

UTC timestamp of fund creation

Example:

"2024-01-01T00:00:00Z"

collaboratorFund.updatedAtUtc

string

required

UTC timestamp of last fund update

Example:

"2024-03-14T12:00:00Z"

collaboratorFund.lifetimeDonationsUsdc

string

required

Total lifetime donations received in USDC with 6 decimal places

Example:

"1000000000"

collaboratorFund.inboundFeeBps

number

required

The fee charged for inbound operations in basis points (1 basis point = 0.01%)

Example:

25

collaboratorFund.outboundFeeBps

number

required

The fee charged for outbound operations in basis points (1 basis point = 0.01%)

Example:

50

collaboratorFund.grantsGiven

number

required

Total number of grants given by this fund

Example:

10

collaboratorFund.inTransitBuyUsdcAmount

string

required

Amount of USDC pending purchase with 6 decimal places

Example:

"5000000"

collaboratorFund.inTransitSellUsdcAmount

string

required

Amount of USDC pending sale with 6 decimal places

Example:

"3000000"

collaboratorFund.investedUsdc

string

required

Total amount invested in USDC with 6 decimal places

Example:

"50000000"

collaboratorFund.totalGrantedUsdc

string

required

Total amount granted in USDC with 6 decimal places

Example:

"25000000"

collaboratorFund.processingTransfersTotalUsdc

string

required

Total amount in processing transfers in USDC with 6 decimal places

Example:

"1000000"

collaboratorFund.illiquidBalance

string

required

Total balance in illiquid portfolios in USDC with 6 decimal places

Example:

"10000000"

collaboratorFund.deploymentTransactionHash

object

Transaction hash of the deployment transaction

Example:

"0xf89f7da1e5d79dcb1b8863d0926fe41204785b443ce2d1dca4bf50070c492567"

collaboratorFund.contractAddress

object

Contract address of the fund

Example:

"0x1234567890123456789012345678901234567890"

collaboratorFund.lastBalanceSyncUtc

object

UTC timestamp of the last balance sync

Example:

"2024-03-14T12:00:00Z"

collaboratorFund.shortDescription

object

Brief description of the fund

Example:

"Supporting education"

collaboratorFund.vanityUrl

object

Custom URL identifier for the fund

Example:

"doe-family-foundation"

collaboratorFund.paypalId

object

PayPal merchant ID associated with the fund

Example:

"123e4567-e89b-12d3-a456-426614174000"

collaboratorFund.logo

object

URL of the fund's logo image

Example:

"https://example.com/logo.png"

collaboratorFund.staffNotes

string | null

Internal notes about the fund (staff only)

collaboratorFund.category

object

Category of the fund (e.g., Education, Health)

Example:

"Education"

collaboratorFund.customFeeDetail

object

Details about why this fund has custom fees. Only set if either inbound or outbound fee is custom

Example:

"Special Community Fund Agreement"

collaborator

object

required

The collaborator who created the recommendation

Show child attributes

collaborator.id

string

required

Unique identifier of the collaboration relationship

Example:

"123e4567-e89b-12d3-a456-426614174000"

collaborator.collaboratorUserId

string

required

Unique identifier of the collaborator

Example:

"123e4567-e89b-12d3-a456-426614174000"

collaborator.fundId

string

required

Unique identifier of the fund

Example:

"123e4567-e89b-12d3-a456-426614174000"

collaborator.email

string

required

Email address of the collaborator

Example:

"[email protected]"

collaborator.firstName

string

required

First name of the collaborator

Example:

"John"

collaborator.lastName

string

required

Last name of the collaborator

Example:

"Doe"

createdAt

string<date-time>

required

The date the recommendation was created

status

enum<string>

required

Status of the recommendation

Available options:

Executed,

Pending,

Dismissed

type

string

required

Type of the recommended activity

Example:

"grant"

Get recommendations created by the current user Get recommendations for a specific fund

⌘I

About

Quickstart

Endpoints

Smart Contracts

Get recommendations for the current user

Authorizations

Response