Search references
Full-text and faceted search over the company's published references
(Elasticsearch-backed). Unlike the plain list endpoint, the response is
wrapped: { total, page, references[], aggregations{} }.
Besides the declared parameters, filter parameters from the
filter definitions are accepted —
e.g. query (free text), city, sinceyear, workfield_ID, method_ID,
product_ID, mediatype, referencetype_ID, and property filters named
f{fieldId}. Send option values comma-separated.
curl -X GET "https://referenzen.com/api/v1/references/search?query=example_string&lang_ID=2&branch_ID=example_string&selection=all&getaggregations=true&getclientdetails=true&getadmininfo=false&format=list&records=10&page=1&orderby=relevance&usecache=true" \
-H "Content-Type: application/json"
import requests
import json
url = "https://referenzen.com/api/v1/references/search?query=example_string&lang_ID=2&branch_ID=example_string&selection=all&getaggregations=true&getclientdetails=true&getadmininfo=false&format=list&records=10&page=1&orderby=relevance&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/search?query=example_string&lang_ID=2&branch_ID=example_string&selection=all&getaggregations=true&getclientdetails=true&getadmininfo=false&format=list&records=10&page=1&orderby=relevance&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/search?query=example_string&lang_ID=2&branch_ID=example_string&selection=all&getaggregations=true&getclientdetails=true&getadmininfo=false&format=list&records=10&page=1&orderby=relevance&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/search?query=example_string&lang_ID=2&branch_ID=example_string&selection=all&getaggregations=true&getclientdetails=true&getadmininfo=false&format=list&records=10&page=1&orderby=relevance&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
{
"total": 42,
"page": 25,
"references": [
{
"reference_ID": 4711,
"projecttitle": "Harbor Bridge Renovation",
"subtitle": "example_string",
"displayedlocation": "Hamburg, Germany",
"country": "USA",
"region": "example_string",
"city": "New York",
"location": "example_string",
"latitude": 3.14,
"longitude": 3.14,
"date": "example_string",
"thumbnail": "example_string",
"uniquename": "John Doe",
"referencedetailpagelink": "example_string",
"seolabel": "example_string",
"company": {
"company_ID": 123,
"companyname": "John Doe",
"detailpagelink": "example_string",
"address": "123 Main St",
"address2": "123 Main St",
"zip": "example_string",
"city": "New York",
"region": "example_string",
"country": "USA"
},
"status": 42,
"projectstatus": 42,
"ispublished": true,
"iscountersigned": true,
"datecountersigned": "example_string",
"countersignstatus": 10,
"isfeatured": true,
"referencetype_ID": 123,
"datecreated": "example_string",
"client": {
"displayedname": "a leading logistics company",
"displayedclientname": "John Doe",
"address": "123 Main St",
"address2": "123 Main St",
"zip": "example_string",
"city": "New York",
"detailpagelink": "example_string",
"mainbranch": "example_string",
"contact_name": "John Doe",
"contact_jobtitle": "example_string"
},
"dateupdated": "example_string",
"updated_by": "example_string"
}
],
"aggregations": {}
}
{}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
/references/search
Target server for requests. Edit to use your own host.
Your API key (workspace → avatar menu → Settings → API). Scopes all requests to your company.
Free-text search phrase.
Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.
Restrict to a branch (single ID includes its sub-branches) or a comma-separated list.
Quick selection.
Include facet buckets in the response.
Page size. Allowed values: 8, 9, 12, 15, 16, 18, 20, 21, 24, 27, 28, 30, 32, 36, 40, 50, 100 (invalid values fall back to 10).
Sort order (invalid values fall back to relevance).
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
Free-text search phrase.
Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.
12Restrict to a branch (single ID includes its sub-branches) or a comma-separated list.
Include facet buckets in the response.
listtilesPage size. Allowed values: 8, 9, 12, 15, 16, 18, 20, 21, 24, 27, 28, 30, 32, 36, 40, 50, 100 (invalid values fall back to 10).
Sort order (invalid values fall back to relevance).
relevancereference_IDreference_ID descdatefromdatefrom descdateuntildateuntil descprojecttitleprojecttitle descsortorderlastviewdatecountersignrequestedResponses
Total number of hits.
Facet buckets keyed by field name. Term buckets are \{V, C\} (value, count);
range buckets are \{V, MIN, MAX, C\}. Keys are uppercase.