Grants & Funding

Funds

The Funds API allows you to retrieve information about funding programmes managed by your organisation. Funds represent grant programmes, funding streams, or financial support mechanisms that your organisation administers.

List Funds

Retrieve a paginated list of funds with optional filtering.

Endpoint

GET /api/v1/funds

Query Parameters

Pagination:

  • limit (number, default: 100, max: 250) - Maximum number of funds to return
  • offset (number, default: 0) - Number of funds to skip for pagination

Filtering:

  • isOpenCall (boolean) - Filter by whether the fund has an open call for applications
  • recipientType (string) - Filter by recipient type:
    • individual - Funds for individual recipients
    • organisation - Funds for organisations

Response

{
  "funds": [
    {
      "fundId": "fund_abc123",
      "managedBy": "org123",
      "name": "Community Development Fund 2025",
      "description": "Supporting local community initiatives and grassroots projects",
      "identifier": "CDF-2025",
      "contact": {
        "name": "Jane Smith",
        "email": "grants@example.org"
      },
      "guidelines": "Applications should demonstrate clear community benefit...",
      "eligibilityCriteria": "Applicants must be registered charities or CICs...",
      "currency": "GBP",
      "financials": {
        "totalAmount": 500000,
        "amountAwarded": 350000,
        "amountDisbursed": 200000,
        "maxGrantSize": 25000
      },
      "dates": {
        "start": "2025-01-01T00:00:00.000Z",
        "end": "2025-12-31T23:59:59.000Z",
        "applicationsOpen": "2025-01-15T09:00:00.000Z",
        "applicationsClose": "2025-03-31T17:00:00.000Z"
      },
      "whatWeFund": "Community spaces, youth programmes, environmental projects",
      "whatWeWontFund": "Capital projects over £50k, overseas activities",
      "isOpenCall": true,
      "recipientType": "organisation",
      "forms": {
        "applicationFormId": "form_app123",
        "assessmentFormId": "form_assess456",
        "monitoringFormIds": ["form_mon789", "form_mon012"]
      },
      "external": {
        "id": "EXT-123",
        "source": "360Giving"
      },
      "created": "2024-12-01T10:00:00.000Z",
      "updated": "2025-01-10T14:30:00.000Z"
    }
  ],
  "offset": 0,
  "limit": 100,
  "total": 12
}

Example Requests

List all funds:

curl -X GET "https://app.plinth.org.uk/api/v1/funds" \
  -H "x-api-key: sk_your_api_key"

Filter open call funds:

curl -X GET "https://app.plinth.org.uk/api/v1/funds?isOpenCall=true" \
  -H "x-api-key: sk_your_api_key"

Filter by recipient type:

curl -X GET "https://app.plinth.org.uk/api/v1/funds?recipientType=organisation" \
  -H "x-api-key: sk_your_api_key"

Get Single Fund

Retrieve a specific fund by ID with detailed configuration.

Endpoint

GET /api/v1/funds/:fundId

Path Parameters

  • fundId (string, required) - The unique identifier of the fund

Response

The single fund response includes additional fields not present in the list view:

{
  "fund": {
    "fundId": "fund_abc123",
    "managedBy": "org123",
    "name": "Community Development Fund 2025",
    "description": "Supporting local community initiatives and grassroots projects",
    "identifier": "CDF-2025",
    "contact": {
      "name": "Jane Smith",
      "email": "grants@example.org"
    },
    "guidelines": "Applications should demonstrate clear community benefit...",
    "eligibilityCriteria": "Applicants must be registered charities or CICs...",
    "currency": "GBP",
    "financials": {
      "totalAmount": 500000,
      "amountAwarded": 350000,
      "amountDisbursed": 200000,
      "maxGrantSize": 25000
    },
    "dates": {
      "start": "2025-01-01T00:00:00.000Z",
      "end": "2025-12-31T23:59:59.000Z",
      "applicationsOpen": "2025-01-15T09:00:00.000Z",
      "applicationsClose": "2025-03-31T17:00:00.000Z"
    },
    "whatWeFund": "Community spaces, youth programmes, environmental projects",
    "whatWeWontFund": "Capital projects over £50k, overseas activities",
    "strengths": "Strong track record of community engagement",
    "weaknesses": "Limited funding for capital projects",
    "isOpenCall": true,
    "recipientType": "organisation",
    "forms": {
      "applicationFormId": "form_app123",
      "assessmentFormId": "form_assess456",
      "monitoringFormIds": ["form_mon789", "form_mon012"]
    },
    "assessment": {
      "simpleAssessment": false,
      "verbosity": 3
    },
    "external": {
      "id": "EXT-123",
      "source": "360Giving"
    },
    "assessors": {
      "userIds": ["user_001", "user_002"],
      "groups": [
        {
          "id": "group_1",
          "name": "Panel A",
          "assessorIds": ["user_003", "user_004"]
        }
      ]
    },
    "geography": {
      "geopoint": {
        "latitude": 51.5074,
        "longitude": -0.1278
      },
      "radius": 50,
      "radiusUnit": "miles",
      "geoMode": "radius",
      "boundaryLocations": "Greater London"
    },
    "applicationNumbering": {
      "latestApplicationNumber": 156,
      "firstApplicationNumber": 1
    },
    "agreement": {
      "templateId": "template_001",
      "requiredGranteeSignatures": 2,
      "requiredFunderSignatures": 1
    },
    "created": "2024-12-01T10:00:00.000Z",
    "updated": "2025-01-10T14:30:00.000Z"
  }
}

Example Request

curl -X GET "https://app.plinth.org.uk/api/v1/funds/fund_abc123" \
  -H "x-api-key: sk_your_api_key"

Response Fields

Fund Object (List)

FieldTypeDescription
fundIdstringUnique identifier for the fund
managedBystringOrganisation ID that manages this fund
namestringFund name
descriptionstringFund description
identifierstringHuman-readable fund identifier/code
contactobjectContact information
guidelinesstringApplication guidelines
eligibilityCriteriastringEligibility requirements
currencystringCurrency code (e.g., GBP, USD)
financialsobjectFinancial summary
datesobjectKey dates
whatWeFundstringTypes of activities funded
whatWeWontFundstringExclusions
isOpenCallbooleanWhether applications are open
recipientTypestringindividual or organisation
formsobjectAssociated form IDs
externalobjectExternal system references
createdstringCreation timestamp (ISO 8601)
updatedstringLast update timestamp (ISO 8601)

Financials Object

FieldTypeDescription
totalAmountnumberTotal fund amount
amountAwardednumberAmount awarded to date
amountDisbursednumberAmount disbursed to date
maxGrantSizenumberMaximum grant size

Dates Object

FieldTypeDescription
startstringFund start date
endstringFund end date
applicationsOpenstringWhen applications open
applicationsClosestringApplication deadline

Additional Fields (Single Fund)

FieldTypeDescription
strengthsstringFund strengths
weaknessesstringFund weaknesses
assessmentobjectAssessment configuration
assessorsobjectAssessor assignments
geographyobjectGeographic targeting
applicationNumberingobjectApplication numbering config
agreementobjectGrant agreement settings

Error Responses

StatusDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
404Not Found - Fund not found
500Internal Server Error
Previous
Case Notes