You might want to display a progress bar on your website for a particular donation form. Simply supply the API with the ID of the donation form in question, along with your organization ID. You can find this information in your form embed code.

___

Base URL

Use the base url: https://platform.funraise.io
GET /api/v1/public/form/<formId>?apiKey=<Your OrganizationId>

___

Parameters

formId – The numeric ID of the form, you can find this in your form embed code

apiKey – your apiKey, you can use your organization ID for this value, this can also be found in the form embed code.

___

Returns

donationCount – the number of donations that belong to this form

goal – the goal amount for this form

percentGoal – the percent of the goal reached

donationTotal – the total amount in USD of donations that belong to this form

lastTransaction – the date of the most recent transaction that belongs to this form

onetimeCount – number of donations that are one-time donations

donorCount – number of unique donors that have made donations to this form

name – the name of the form

Example API Call:

GET https://platform.funraise.io/api/v1/public/form/43?apiKey=29659734-9cec-4761-aa65-d2b3f605aa9b

{
   "result":{
      "donationCount":185,
      "goal":0,
      "recurringCount":0,
      "percentGoal":0,
      "donationTotal":18289,
      "lastTransaction":"2016-06-21",
      "onetimeCount":185,
      "donorCount":176,
      "name":"Baby Lisa Gift"
   }
}

Did this answer your question?