Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
131 lines (99 sloc) 2.08 KB

Client tags list

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

For betterplace.org clients only:

This API returns all tags defined for a client.

Results are contained in a data attribute.

URL Parameters

Parameter Example Required Description
client_id volksfreund yes

The betterplace.org-internal client id

Response Attributes

Root Attributes

Attribute Types Example Description
tag string "Education"

The name of the tag. It is unique per client.

projects_count number 23

The number of projects that were tagged with this tag.

Response Links

Linkname Description

projects

Link to the client-tag projects list – all projects that are tagged with given client-tag.

Response Example

{
  "total_entries": 13,
  "offset": 0,
  "total_pages": 7,
  "current_page": 1,
  "per_page": 2,
  "data": [
    {
      "tag": "Bedürftige",
      "projects_count": 12,
      "links": [
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/clients/heidenheim/tags/Bed%C3%BCrftige/projects.json"
        }
      ]
    },
    {
      "tag": "Inklusion",
      "projects_count": 8,
      "links": [
        {
          "rel": "projects",
          "href": "https://api.betterplace.org/de/api_v4/clients/heidenheim/tags/Behinderte/projects.json"
        }
      ]
    }
  ]
}