Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

Organisations List ⇄ Details

GET https://api.betterplace.org/de/api_v4/organisations.json

A list of betterplace.org organisations. Results are contained in a data attribute. The details and list view show the same data per organisation.

For betterplace.org clients: This resource is not available at the moment.

URL Parameters

Parameter Example Required Description

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)

latitude number 52.499007

Decimal degrees based on user input

longitude number 13.44947

Decimal degrees based on user input

street null | string "Schlesische Straße 26"

Street address

zip null | string "10997"

ZIP code

city null | string "Berlin"

Name of the city

country null | string "Deutschland"

Name of the country

content_updated_at string "1994-11-05T13:15:30Z"

DateTime (ISO8601 with Timezone)

slug string vivaconagua

URL slug for the permalink

name string "Viva con Agua de Sankt Pauli e.V."

Name of the organisation

description string

A description of the organisation. This may contain br tags.

tax_deductible boolean true

⚠️ DEPRECATED!

This value is deprecated and will be removed.

↓contact object

The public contact person for this organisation.

↓picture null | object

TODO

↑Nested Attributes: contact

Attribute Types Example Description
contact.id number 1

An integer number ≥ 1

contact.name null | string "Till B."

Display name of a betterplace.org user. Possible formats: "Till B.", "T. Behnke", "Till Behnke".

In the case of donation-opinions the name might also be empty/null for anonymous donations for anonymous donations.

↓contact.picture object //betterplace-assets.betterplace.org ↪/uploads/user/profile_picture ↪/000/000/001 ↪/fill_100x100_original_tb.jpg

User profile picture or a fallback image

↑Nested Attributes: contact.picture

Attribute Types Example Description
contact.picture.fallback boolean true

Specifies whether a fallback image is given or not

↑Nested Attributes: picture

Attribute Types Example Description
picture.fallback boolean true

Specifies whether a fallback image is given or not

Response Links

Linkname Description

self

Link to this resource itself (organisation details)

platform

Permalink to betterplace.org

projects

Link to the project list of this organisation

website

Link to the website of this organisation.

contact.platform

The user's profile on betterplace.org. To view a user profile you have to be logged in. This array is empty if the user has no useraccount with betterplace.org but donated via one of our partner.

contact.contact_data

The user's contact data. Please note that you need to be authenticated as a client with matching access rights in order to see this information.

contact.picture.fill_100x100

100×100 Pixel

contact.picture.original

Maximum sized image. This is the original image with default-cropping or user-cropping applied.

picture.fill_100x100

100×100 Pixel

picture.fill_200x200

200×200 Pixel

picture.fill_400x400

400×400 Pixel

picture.original

Maximum sized image. This is the original image with default-cropping or user-cropping applied.

Response Example

{
  "total_entries": 2,
  "offset": 0,
  "total_pages": 1,
  "current_page": 1,
  "per_page": 2,
  "data": [
    {
      "id": 2262,
      "created_at": "2009-11-02T16:12:49+01:00",
      "updated_at": "2018-11-07T09:18:16+01:00",
      "latitude": 50.91569900512695,
      "longitude": 6.94116020202637,
      "street": "Stettiner Straße 82",
      "zip": "50969",
      "city": "Köln",
      "country": "Deutschland",
      "content_updated_at": "2018-06-29T09:01:05+02:00",
      "slug": "unicef",
      "name": "UNICEF",
      "description": "UNICEF, das Kinderhilfswerk der Vereinten Nationen, arbeitet weltweit mit Programmen in rund 150 Ländern. UNICEF hilft, dass das Recht jedes Kindes auf Überleben, Bildung und Schutz Wirklichkeit wird: mit konkreten Projekten, umfassenden Programmen und politischer Lobbyarbeit. UNICEF ist in jedem Land seit vielen Jahren vor Ort und hat ein dichtes Netzwerk lokaler Partner. So ist nachhaltige und effiziente Hilfe möglich. Mit dem jährlichen Geschäftsbericht informiert UNICEF ausführlich über Arbeitsweise, Strukturen und Kosten. Sie finden ihn unter www.unicef.de",
      "tax_deductible": true,
      "contact": {
        "id": 20505,
        "name": "Jana Schuhmacher (display)",
        "picture": {
          "links": [
            {
              "rel": "fill_100x100",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/020/505/fill_100x100_bp1628225975_UNICEF_Logo.jpg"
            },
            {
              "rel": "original",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/020/505/crop_original_bp1628225975_UNICEF_Logo.jpg"
            }
          ]
        },
        "links": [
          {
            "rel": "platform",
            "href": "https://www.betterplace.org/de/users/20505"
          },
          {
            "rel": "contact_data",
            "href": "https://api.betterplace.org/de/api_v4/users/20505/contact_data.json"
          }
        ]
      },
      "picture": {
        "links": [
          {
            "rel": "fill_100x100",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/fill_100x100_bp1530255665_UNICEF_fuerjedesKind_Cyan_Vertical_RGB.jpg"
          },
          {
            "rel": "fill_200x200",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/fill_200x200_bp1530255665_UNICEF_fuerjedesKind_Cyan_Vertical_RGB.jpg"
          },
          {
            "rel": "fill_400x400",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/fill_400x400_bp1530255665_UNICEF_fuerjedesKind_Cyan_Vertical_RGB.jpg"
          },
          {
            "rel": "original",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/002/262/crop_original_bp1530255665_UNICEF_fuerjedesKind_Cyan_Vertical_RGB.jpg"
          }
        ]
      },
      "links": [
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/organisations/2262.json"
        },
        {
          "rel": "platform",
          "href": "https://www.betterplace.org/de/organisations/2262-unicef"
        },
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/organisations/2262/projects.json"
        },
        {
          "rel": "website",
          "href": "http://www.unicef.de"
        }
      ]
    },
    {
      "id": 125,
      "created_at": "2008-02-06T17:10:42+01:00",
      "updated_at": "2022-02-11T00:01:12+01:00",
      "latitude": 53.55759811401367,
      "longitude": 9.96815967559815,
      "street": "Mühlgasse 175",
      "zip": "20357",
      "city": "Hamburg",
      "country": "Deutschland",
      "content_updated_at": "2020-04-09T18:24:12+02:00",
      "slug": "vivaconagua",
      "name": "Viva con Agua de Sankt Pauli e.V.",
      "description": "Viva con Agua aktiviert und inspiriert - für eine Welt ohne Durst!<br><br>Viva con Agua ist ein internationales Netzwerk von Menschen und Organisationen, das sich für den sicheren Zugang zu sauberem Trinkwasser und sanitärer Grundversorgung einsetzt. <br>2006 wurde der gemeinnützige Verein Viva con Agua de Sankt Pauli ins Leben gerufen. <br>Inzwischen unterstützen die Vision „WASSER FÜR ALLE – ALLE FÜR WASSER“ mehr als 15.000 ehrenamtliche Supporter, die mit zahlreichen Aktionen und ebenso viel Spaß Spenden für WASH-Projekte weltweit sammeln – darunter viele Künstler und Musiker. <br>Gemeinsam seinen internationalen und lokalen Partnerorganisationen konnte die Bewegung so bereits über drei Millionen Menschen in WASH-Projekten (WAter, Sanitation, Hygiene) erreichen.<br><br>Neben dem Hamburger Verein zählen mittlerweile die Viva con Agua Stiftung und lokal aktive Organisationen in Uganda, Österreich, den Niederlanden, der Schweiz und neuerdings in Südafrika und Kalifornien zum international tätigen Netzwerk. Darüber hinaus unterstützen die ausgegründeten Social Business Unternehmen Viva con Agua Wasser GmbH, Viva con Agua ARTS gGmbH und Goldeimer gGmbH mit ihren Aktivitäten die Trinkwasser- und Sanitärprojekte von VcA.<br><br>WASSER FÜR ALLE - ALLE FÜR WASSER!",
      "tax_deductible": true,
      "contact": {
        "id": 561728,
        "name": "Lucas\tMason\tAlexander Köhler (display)",
        "picture": {
          "links": [
            {
              "rel": "fill_100x100",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/561/728/fill_100x100_bp1587649479_VCA_Tropfen.png"
            },
            {
              "rel": "original",
              "href": "https://betterplace-assets.betterplace.org/uploads/user/profile_picture/000/561/728/crop_original_bp1587649479_VCA_Tropfen.png"
            }
          ]
        },
        "links": [
          {
            "rel": "platform",
            "href": "https://www.betterplace.org/de/users/561728"
          },
          {
            "rel": "contact_data",
            "href": "https://api.betterplace.org/de/api_v4/users/561728/contact_data.json"
          }
        ]
      },
      "picture": {
        "links": [
          {
            "rel": "fill_100x100",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/fill_100x100_VcA_Projektlogo.jpg"
          },
          {
            "rel": "fill_200x200",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/fill_200x200_VcA_Projektlogo.jpg"
          },
          {
            "rel": "fill_400x400",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/fill_400x400_VcA_Projektlogo.jpg"
          },
          {
            "rel": "original",
            "href": "https://betterplace-assets.betterplace.org/uploads/organisation/profile_picture/000/000/125/crop_original_VcA_Projektlogo.jpg"
          }
        ]
      },
      "links": [
        {
          "rel": "self",
          "href": "https://api.betterplace.org/de/api_v4/organisations/125.json"
        },
        {
          "rel": "platform",
          "href": "https://www.betterplace.org/de/organisations/125-viva-con-agua-de-sankt-pauli-e-v"
        },
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/organisations/125/projects.json"
        },
        {
          "rel": "website",
          "href": "http://www.vivaconagua.org"
        }
      ]
    }
  ]
}