Skip to content

Latest commit

 

History

History
193 lines (138 loc) · 3.3 KB

client_details.md

File metadata and controls

193 lines (138 loc) · 3.3 KB
Raw

Client Details

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

This API endpoint returns links to more specific information about this client.

URL Parameters

Parameter Example Required Description
id volksfreund yes

The betterplace.org-internal client permalink

Response Attributes

No response example defined

Response Links

Linkname Description

projects

Link to the project list of this client

volunteering

Link to the volunteering list of this client

client_donations

Link to the client donations list of this client

client_project_tags

Link to the tags list of this client

client_fundraising_events

Link to the fundraising events list of this client

project_mailing_subscriptions

Link to the templated client mailing subscriptions of this client. Replace {project_id} with the ID of a project that is part of you client projects list.

project_statistics

Link to the project statistics of this client

fundraising_event_statistics

Link to the fundraising event statistics of this client

Response Example

{
  "links": [
    {
      "rel": "projects",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/projects.json"
    },
    {
      "rel": "volunteering",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/volunteering.json"
    },
    {
      "rel": "client_donations",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/client_donations.json"
    },
    {
      "rel": "client_project_tags",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/tags.json"
    },
    {
      "rel": "client_fundraising_events",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/fundraising_events.json"
    },
    {
      "rel": "project_mailing_subscriptions",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/projects/%7Bproject_id%7D/mailing_subscriptions.json",
      "templated": true
    },
    {
      "rel": "project_statistics",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/project_statistics.json"
    },
    {
      "rel": "fundraising_event_statistics",
      "href": "https://api.betterplace.org/de/api_v4/clients/volksfreund/fundraising_event_statistics.json"
    }
  ]
}