ExportBulk export (Excel/JSON)

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"
[
  {
    "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"
  }
]
GET
/references/export
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
loginstring
Required

User login (e-mail) — additional authentication.

query
passwordstring
Required

User password — additional authentication.

Format: password
query
formatstring
Required
Options: excel, json
query
optionsstring

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.

query
field_IDliststring

Company-specific additional field IDs to include as extra columns.

query
publishedboolean

Export only published references (true) or all (false).

query
lang_IDinteger

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

Options: 1, 2
query
orderbystring
Options: reference_ID, reference_ID desc, datefrom, datefrom desc, dateuntil, dateuntil desc, projecttitle, projecttitle desc, random
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

loginstring
Required

User login (e-mail) — additional authentication.

passwordstring
Required

User password — additional authentication.

formatstring
Required
Allowed values:exceljson
optionsstring

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.

field_IDliststring

Company-specific additional field IDs to include as extra columns.

publishedboolean

Export only published references (true) or all (false).

lang_IDinteger

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

Allowed values:12
orderbystring
Allowed values:reference_IDreference_ID descdatefromdatefrom descdateuntildateuntil descprojecttitleprojecttitle descrandom

Responses

reference_IDinteger
customidentifierstring
projecttitlestring
publishedboolean
isconfirmedboolean
datecreatedstring
authorstring
locationstring
zipcodestring
citystring
regionstring
countrystring
datestring
datefromstring
dateuntilstring
subtitlestring
descriptionstring
branchesstring[]
referencegroupsstring[]
imagecountinteger
tagsstring[]
clienttypestring
Allowed values:companyprivate
clientnamestring
clientaddressstring
clientzipstring
clientcitystring
clientregionstring
clientcountrystring
contactstring
companylocationnamestring
contracttypestring
contractvaluestring
referencedetailpagelinkstring
referencequicklinkstring
markerlistnotesstring