Skip to content

Latest commit

 

History

History
147 lines (110 loc) · 2.39 KB

pool_details.md

File metadata and controls

147 lines (110 loc) · 2.39 KB
Raw

Pool Details

GET https://api.betterplace.org/de/api_v4/clients/payback/pool.json

The details of a betterplace.org client pool.

The result is cached for 5 minutes.

🔒 Only available if authenticated as a client. See betterplace.org clients.

For betterplace.org clients: Use this resource as follows: /clients/PERMALINK/pool.json

URL Parameters

Parameter Example Required Description
client_id payback yes

The betterplace.org-internal client permalink.

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)
donated_amount_in_cents number 232323

The amount in cents this pool has received
forwarded_amount_in_cents number 12300

The amount in cents the pool has forwarded to projects.

Response Links

Linkname Description

self

Link to this resource itself (pool details)

Response Example

{
  "id": 4,
  "created_at": "2016-01-14T15:12:34+01:00",
  "updated_at": "2019-12-16T19:35:24+01:00",
  "donated_amount_in_cents": 96851700,
  "forwarded_amount_in_cents": 96790054,
  "links": [
    {
      "rel": "self",
      "href": "https://api.betterplace.org/de/api_v4/clients/payback/pool.json"
    }
  ]
}