ReferencesGet filter definitions

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"
[
  {
    "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
      }
    ]
  }
]
GET
/references/filters
GET
Base URLstring

Target server for requests. Edit to use your own host.

API Key (query: apiKey)
apiKeystring
Required

Your API key (workspace → avatar menu → Settings → API). Scopes all requests to your company.

Your API key (workspace → avatar menu → Settings → API). Scopes all requests to your company.
query
branch_IDinteger

Scope the filter definitions to one branch.

query
lang_IDinteger

Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.

Options: 1, 2
query
getunusedoptionsboolean

Include options with zero hits.

Request Preview
Response

Response will appear here after sending the request

Authentication

query
apiKeystring
Required

API Key for authentication. Your API key (workspace → avatar menu → Settings → API). Scopes all requests to your company.

Query Parameters

branch_IDinteger

Scope the filter definitions to one branch.

lang_IDinteger

Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.

Allowed values:12
getunusedoptionsboolean

Include options with zero hits.

Responses

namestring

The query parameter to send to the search endpoint (e.g. workfield_ID, city, f1234).

labelstring

Localized display label.

sortmodestring

Suggested option ordering (hitcountdesc or predefined).

datatypestring

Option value type (e.g. multi-string, integer, multi-integer).

formtypestring

Suggested widget (e.g. multiselect-checkboxes, radiobuttons).

openedinteger

1 = render expanded, 2 = collapsed.

internalinteger

1 for company-internal property filters (only on f{fieldId} definitions).

workfield_IDinteger

Owning work field (only on f{fieldId} definitions).

optionsarray