matching_funds_list.md

Matching Funds List ⇄ Details

GET https://api.betterplace.org/de/api_v4/matching_funds.json?facets=state%3Aactivated

A list of betterplace.org matching funds.

URL Parameters

Parameter	Example	Required	Description
project_id	28013	no	Optional project id as an integer number ≥ 14. Allows to filter the list of matching funds. This way one can show a list of matching funds where the given project is part of the matching fund projects list.
facets	state:activated	no	Filter the result set by state (activated|closed) Learn how to format the parameter.

Response Attributes

Root Attributes

Attribute	Types	Example	Description
id	number	1	An integer number ≥ 1
created_at	string	"1994-11-05T13:15:30Z"	DateTime (ISO8601 with Timezone)
updated_at	string	"1994-11-05T13:15:30Z"	DateTime (ISO8601 with Timezone)
activated_at	null | string	"1994-11-05T13:15:30Z"	DateTime (ISO8601 with Timezone)
title	string	ACME Matching Everything	Our matching fund's name
description	string	It's all about matching donations…	The description of the matching fund
company_name	string	ACME	The company that supports it
client_id	string	clientname	The client to which the matching fund belongs
provided_amount_in_cents	number	12300	The amount in cents the company provided to be matched
donated_amount_in_cents	number	12300	The amount in cents the company already donated
state	string	activated	Current state of this matching fund: either activated or closed
logo_url	string	http://example.com/images/logo.png	The URL of the logo image.
maximum_matching_amount_in_cents	number	10000	Up to this amount donations get matched by the matching fund

Response Links

Linkname	Description
self	Link to this resource itself (matching fund details)
platform	Permalink to betterplace.org
projects	Link to the list of projects belonging to this matching fund
documentation	Link to this resource in the documentation

Response Example

{
  "total_entries": 9,
  "offset": 0,
  "total_pages": 5,
  "current_page": 1,
  "per_page": 2,
  "data": [
    {
      "id": 11,
      "created_at": "2015-10-29T17:06:32+01:00",
      "updated_at": "2016-10-27T16:34:28+02:00",
      "activated_at": "2015-10-31T08:33:12+01:00",
      "title": "Fressnapf verdoppelt deine Spende",
      "description": "",
      "company_name": "Fressnapf",
      "client_id": "fressnapf",
      "provided_amount_in_cents": 1000000,
      "donated_amount_in_cents": 1000000,
      "state": "closed",
      "logo_url": "https://www.betterplace.dev/uploads/matching_fund/logo/000/000/011/bp1477578868_Logo_Fressnapf.png",
      "maximum_matching_amount_in_cents": 10000,
      "links": [
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/matching_funds/11.json"
        },
        {
          "rel": "platform",
          "href": "https://www.betterplace.org/de/matching-funds/11-fressnapf"
        },
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/matching_funds/11/projects.json"
        },
        {
          "rel": "documentation",
          "href": "https://github.com/betterplace/betterplace_apidocs/blob/master/sections/matching_fund_details.md"
        }
      ]
    },
    {
      "id": 34,
      "created_at": "2016-04-13T15:57:01+02:00",
      "updated_at": "2016-11-29T14:54:07+01:00",
      "activated_at": "2016-07-07T09:59:35+02:00",
      "title": "2016-07-07 Gut für Köln und Bonn",
      "description": "Die Sparkasse KölnBonn verdoppelt Deine Spende auf gut-fuer-koeln-und-bonn.de!",
      "company_name": "Die Sparkasse KölnBonn",
      "client_id": "sk-koelnbonn",
      "provided_amount_in_cents": 997500,
      "donated_amount_in_cents": 997500,
      "state": "closed",
      "logo_url": null,
      "maximum_matching_amount_in_cents": 10000,
      "links": [
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/matching_funds/34.json"
        },
        {
          "rel": "platform",
          "href": "https://www.betterplace.org/de/matching-funds/34-die-sparkasse-koelnbonn"
        },
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/matching_funds/34/projects.json"
        },
        {
          "rel": "documentation",
          "href": "https://github.com/betterplace/betterplace_apidocs/blob/master/sections/matching_fund_details.md"
        }
      ]
    }
  ]
}