Get filter definitions
Returns the filter definitions (facets) available for the company's catalog —
ready to render as a filter sidebar. Each definition names the query parameter to
use with the search endpoint (name), a localized label, the suggested widget
(formtype), and its options with hit counts.
Always included: sinceyear, referencetype_ID, mediatype, selection.
Included when data exists: city, workfield_ID, method_ID, product_ID,
and one f{fieldId} definition per filterable project property.
curl -X GET "https://referenzen.com/api/v1/references/filters?branch_ID=0&lang_ID=2&getunusedoptions=true&usecache=true" \
-H "Content-Type: application/json"
import requests
import json
url = "https://referenzen.com/api/v1/references/filters?branch_ID=0&lang_ID=2&getunusedoptions=true&usecache=true"
headers = {
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://referenzen.com/api/v1/references/filters?branch_ID=0&lang_ID=2&getunusedoptions=true&usecache=true", {
method: "GET",
headers: {
"Content-Type": "application/json"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://referenzen.com/api/v1/references/filters?branch_ID=0&lang_ID=2&getunusedoptions=true&usecache=true", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://referenzen.com/api/v1/references/filters?branch_ID=0&lang_ID=2&getunusedoptions=true&usecache=true')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
response = http.request(request)
puts response.body
[
{
"name": "John Doe",
"label": "example_string",
"sortmode": "example_string",
"datatype": "example_string",
"formtype": "example_string",
"opened": 42,
"internal": 42,
"workfield_ID": 123,
"options": [
{
"v": "null",
"d": "example_string",
"c": 42,
"min": 3.14,
"max": 3.14
}
]
}
]
{}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
/references/filters
Target server for requests. Edit to use your own host.
Your API key (workspace → avatar menu → Settings → API). Scopes all requests to your company.
Scope the filter definitions to one branch.
Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.
Include options with zero hits.
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Your API key (workspace → avatar menu → Settings → API). Scopes all requests to your company.
Query Parameters
Scope the filter definitions to one branch.
Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.
12Include options with zero hits.
Responses
The query parameter to send to the search endpoint (e.g. workfield_ID, city, f1234).
Localized display label.
Suggested option ordering (hitcountdesc or predefined).
Option value type (e.g. multi-string, integer, multi-integer).
Suggested widget (e.g. multiselect-checkboxes, radiobuttons).
1 = render expanded, 2 = collapsed.
1 for company-internal property filters (only on f{fieldId} definitions).
Owning work field (only on f{fieldId} definitions).