Funds

Add a trusted collaborator to a fund

Adds a collaborator to a fund through a trusted tech platform integration.

Authorization Requirements

This endpoint requires two headers:

x-api-key: The tech platform’s secret API key
Authorization: Bearer token containing the user’s access token

How it works

Tech Platforms can add collaborators via this trusted API call
All collaborators added through this endpoint are implicitly trusted
Tech Platforms must provide:
1. User Access token (generated during OAuth) to prove the user authorized modifying their Fund
2. The Tech Platform’s API Key to prove the request is coming from a trusted source

POST

funds

{id}

collaborators

trust

curl --request POST \
  --url https://api.endaoment.org/v1/funds/{id}/collaborators/trust \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "companyName": "Acme Corporation",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "collaboratorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "fundId": "123e4567-e89b-12d3-a456-426614174000",
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe"
}

Authorizations

Authorization

string

header

required

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

Headers

x-api-key

string

required

Tech Platform API Key

Path Parameters

string

required

The unique identifier of the fund

Body

application/json

Collaborator information to be added to the fund

The body is of type object.

Response

200

application/json

Collaborator successfully added to the fund

The response is of type object.

Create a new fund Remove a collaborator from a fund

curl --request POST \
  --url https://api.endaoment.org/v1/funds/{id}/collaborators/trust \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "companyName": "Acme Corporation",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "collaboratorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "fundId": "123e4567-e89b-12d3-a456-426614174000",
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe"
}

About

Quickstart

Endpoints

Transactions

Subgraph Documentation

Add a trusted collaborator to a fund

Authorization Requirements

How it works

Authorizations

Headers

Path Parameters

Body

Response