Bulk export (Excel/JSON)
Exports the company's complete reference list — including unpublished references and internal fields — as an Excel file or JSON array.
Back-office use only. In addition to the API key, this endpoint requires the
login and password of a user belonging to the company. Never call it from
browser code.
curl -X GET "https://referenzen.com/api/v1/references/export?login=example_string&password=example_string&format=excel&options=example_string&field_IDlist=example_string&published=false&lang_ID=2&orderby=reference_ID%20desc" \
-H "Content-Type: application/json"
import requests
import json
url = "https://referenzen.com/api/v1/references/export?login=example_string&password=example_string&format=excel&options=example_string&field_IDlist=example_string&published=false&lang_ID=2&orderby=reference_ID%20desc"
headers = {
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://referenzen.com/api/v1/references/export?login=example_string&password=example_string&format=excel&options=example_string&field_IDlist=example_string&published=false&lang_ID=2&orderby=reference_ID%20desc", {
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/export?login=example_string&password=example_string&format=excel&options=example_string&field_IDlist=example_string&published=false&lang_ID=2&orderby=reference_ID%20desc", 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/export?login=example_string&password=example_string&format=excel&options=example_string&field_IDlist=example_string&published=false&lang_ID=2&orderby=reference_ID%20desc')
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
[
{
"reference_ID": 123,
"customidentifier": "example_string",
"projecttitle": "example_string",
"published": true,
"isconfirmed": true,
"datecreated": "example_string",
"author": "example_string",
"location": "example_string",
"zipcode": "example_string",
"city": "New York",
"region": "example_string",
"country": "USA",
"date": "example_string",
"datefrom": "example_string",
"dateuntil": "example_string",
"subtitle": "example_string",
"description": "example_string",
"branches": [
"example_string"
],
"referencegroups": [
"example_string"
],
"imagecount": 25,
"tags": [
"example_string"
],
"clienttype": "company",
"clientname": "John Doe",
"clientaddress": "123 Main St",
"clientzip": "example_string",
"clientcity": "New York",
"clientregion": "example_string",
"clientcountry": "USA",
"contact": "example_string",
"companylocationname": "John Doe",
"contracttype": "example_string",
"contractvalue": "example_string",
"referencedetailpagelink": "example_string",
"referencequicklink": "example_string",
"markerlistnotes": "example_string"
}
]
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
/references/export
Target server for requests. Edit to use your own host.
Your API key (workspace → avatar menu → Settings → API). Scopes all requests to your company.
User login (e-mail) — additional authentication.
User password — additional authentication.
Comma-separated column tokens: d description, cl client, c confirmed,
l link, ql quick link, b service branches, rg reference groups,
rgp group paths, p published status, lo responsible location,
cid custom identifier, cu contact user, cv contract type/value,
i image count, tag tags, m marker-list notes.
Default: d,cl,c,p,l,ql,b,rg,p,lo,cid,cu,cv,i,tag.
Company-specific additional field IDs to include as extra columns.
Export only published references (true) or all (false).
Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.
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
User login (e-mail) — additional authentication.
User password — additional authentication.
exceljsonComma-separated column tokens: d description, cl client, c confirmed,
l link, ql quick link, b service branches, rg reference groups,
rgp group paths, p published status, lo responsible location,
cid custom identifier, cu contact user, cv contract type/value,
i image count, tag tags, m marker-list notes.
Default: d,cl,c,p,l,ql,b,rg,p,lo,cid,cu,cv,i,tag.
Company-specific additional field IDs to include as extra columns.
Export only published references (true) or all (false).
Content language: 1 = English, 2 = German. Invalid values fall back to the key owner's default language.
12reference_IDreference_ID descdatefromdatefrom descdateuntildateuntil descprojecttitleprojecttitle descrandomResponses
companyprivate