ReferencesGet a single reference

Get a single reference

Returns the full detail of one published reference — media, services, branch-specific properties, client, partners, and awards. Identify the reference either by reference_ID or by seolabel.

Each successful call counts a view in the company's statistics (channel: API).

curl -X GET "https://referenzen.com/api/v1/references/referenceproject?reference_ID=123&seolabel=example_string&lang_ID=2&preventduplicatefields=true" \
  -H "Content-Type: application/json"
{
  "reference_ID": 123,
  "projecttitle": "example_string",
  "subtitle": "example_string",
  "description": "example_string",
  "lang_ID": 123,
  "isconfirmed": true,
  "referencedetailpagelink": "example_string",
  "displayedlocation": "example_string",
  "continent": "example_string",
  "country": "USA",
  "region": "example_string",
  "city": "New York",
  "location": "example_string",
  "date": "example_string",
  "company": {},
  "responsiblecompanylocation": {},
  "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"
    }
  ],
  "referencegroups": [
    {
      "group_ID": 123,
      "group": "example_string"
    }
  ],
  "branches": [
    {
      "branch_ID": 123,
      "branchname": "John Doe",
      "seolabel": "example_string",
      "path": [
        {
          "branch_ID": 123,
          "branchname": "John Doe",
          "seolabel": "example_string"
        }
      ]
    }
  ],
  "usedproducts": [
    {
      "product_ID": 123,
      "productname": "John Doe",
      "teaser": "example_string",
      "description": "example_string",
      "companyname": "John Doe",
      "URL": "example_string",
      "status": 42
    }
  ],
  "services": [
    {
      "workfieldname": "John Doe",
      "workfieldservices": [
        {
          "service_ID": 123,
          "servicename": "John Doe",
          "seolabel": "example_string",
          "teaser": "example_string",
          "description": "example_string",
          "status": 42
        }
      ]
    }
  ],
  "properties": [
    {
      "section_ID": 123,
      "sectiontitle": "example_string",
      "teaser": "example_string",
      "branch_ID": 123,
      "branchname": "John Doe",
      "fields": [
        {
          "field_ID": 123,
          "title": "example_string",
          "description": "example_string",
          "formtype": 42,
          "status": 42,
          "internal": true,
          "value": "example_string",
          "values": [
            "example_string"
          ]
        }
      ]
    }
  ],
  "internalproperties": [
    {
      "field_ID": 123,
      "title": "example_string",
      "description": "example_string",
      "formtype": 42,
      "status": 42,
      "internal": true,
      "value": "example_string",
      "values": [
        "example_string"
      ]
    }
  ],
  "contractvalue": "example_string",
  "contracttype": "example_string",
  "employed": "example_string",
  "video": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "panorama360": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "widestageimages": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "portraitstageimages": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "galleryimages": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "audio": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "presentation_document": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "press_document": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "download_document": [
    {
      "title": "example_string",
      "description": "example_string",
      "file": "example_string",
      "medialink": "example_string",
      "thumb": "example_string",
      "isstage": true,
      "display_text": "example_string"
    }
  ],
  "countersignstatements": [
    {
      "contactquote_ID": 123,
      "statement": "example_string",
      "displayedname": "John Doe"
    }
  ],
  "awards": [
    {
      "award_ID": 123,
      "awardname": "John Doe",
      "seolabel": "example_string",
      "year": 42
    }
  ],
  "partners": [
    {
      "partner_ID": 123,
      "companyname": "John Doe",
      "partnerrole": "example_string",
      "detailpagelink": "example_string",
      "logo": "example_string"
    }
  ]
}
GET
/references/referenceproject
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
reference_IDinteger

The reference ID (alternative to seolabel).

query
seolabelstring

The reference's SEO label (alternative to reference_ID).

query
lang_IDinteger

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

Options: 1, 2
query
preventduplicatefieldsboolean

Suppress duplicate additional fields shared across branches/work fields.

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

reference_IDinteger

The reference ID (alternative to seolabel).

seolabelstring

The reference's SEO label (alternative to reference_ID).

lang_IDinteger

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

Allowed values:12
preventduplicatefieldsboolean

Suppress duplicate additional fields shared across branches/work fields.

Responses

reference_IDinteger
projecttitlestring
subtitlestring
descriptionstring

HTML.

lang_IDinteger
isconfirmedboolean
referencedetailpagelinkstring
displayedlocationstring
continentstring
countrystring
regionstring
citystring
locationstring
datestring
companyobject

Service provider with release-level-gated contact fields.

responsiblecompanylocationobject
clientarray
referencegroupsarray
branchesarray
usedproductsarray
servicesarray

Services grouped by work field.

propertiesarray

Branch-specific project properties, grouped in sections.

internalpropertiesarray

Internal fields the company flagged as publicly visible.

contractvaluestring

Release-level gated.

contracttypestring

Release-level gated.

employedstring

Employees involved; release-level gated.

videoarray
panorama360array
widestageimagesarray
portraitstageimagesarray
galleryimagesarray
audioarray
presentation_documentarray
press_documentarray
download_documentarray
countersignstatementsarray

Client confirmation quotes.

awardsarray
partnersarray