ReferencesList published references

List published references

Returns the company's published references (API channel) as a paginated list. The response is a bare JSON array without a pagination envelope — use mode=countonly in a separate call to obtain the total count.

The mode parameter switches the payload shape:

  • paging / full (default) — array of full list items
  • IDonly — array of { reference_ID }
  • optionsonly — array of { reference_ID, projecttitle }
  • countonly — a bare integer (total count)
curl -X GET "https://referenzen.com/api/v1/references/referenceprojects?mode=paging&lang_ID=2&idList=example_string&branch_ID=example_string&branch_lft=0&branch_rgt=0&referencegroup_ID=example_string&workfield_ID=example_string&markerlist_ID=0&confirmed=false&ongoing=false&withoutreference_ID=example_string&getclientdetails=false&getadmininfo=false&format=list&records=0&page=1&orderby=sortorder" \
  -H "Content-Type: application/json"
[
  {
    "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"
  }
]
GET
/references/referenceprojects
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
modestring

Payload shape (see endpoint description).

Options: paging, full, optionsonly, IDonly, countonly
query
lang_IDinteger

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

Options: 1, 2
query
idListstring

Comma-separated list of reference IDs to fetch explicitly (bypasses other filters).

query
branch_IDstring

Filter by industry branch — single ID or comma-separated list.

query
branch_lftinteger

Nested-set left bound — include all sub-branches of a branch (use together with branch_rgt).

query
branch_rgtinteger

Nested-set right bound (see branch_lft).

query
referencegroup_IDstring

Filter by reference group — single ID or comma-separated list.

query
workfield_IDstring

Filter by work field — single ID or comma-separated list.

query
markerlist_IDinteger

Filter by a marker list (watchlist) ID.

query
confirmedboolean

Only client-confirmed (countersigned) references.

query
ongoingboolean

Only ongoing projects.

query
withoutreference_IDstring

Exclude these reference IDs (comma-separated).

query
getclientdetailsboolean

Include the client sub-object on each item.

query
getadmininfoboolean

Include dateupdated / updated_by fields.

query
formatstring

Thumbnail size variant.

Options: list, tiles
query
recordsinteger

Page size (0 = no paging).

query
orderbystring

Sort order.

Options: none, reference_ID, reference_ID desc, datefrom, datefrom desc, dateuntil, dateuntil desc, projecttitle, projecttitle desc, sortorder, markerlistsortorder, lastviewdate, countersignrequested, 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

modestring

Payload shape (see endpoint description).

Allowed values:pagingfulloptionsonlyIDonlycountonly
lang_IDinteger

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

Allowed values:12
idListstring

Comma-separated list of reference IDs to fetch explicitly (bypasses other filters).

branch_IDstring

Filter by industry branch — single ID or comma-separated list.

branch_lftinteger

Nested-set left bound — include all sub-branches of a branch (use together with branch_rgt).

branch_rgtinteger

Nested-set right bound (see branch_lft).

referencegroup_IDstring

Filter by reference group — single ID or comma-separated list.

workfield_IDstring

Filter by work field — single ID or comma-separated list.

markerlist_IDinteger

Filter by a marker list (watchlist) ID.

confirmedboolean

Only client-confirmed (countersigned) references.

ongoingboolean

Only ongoing projects.

withoutreference_IDstring

Exclude these reference IDs (comma-separated).

getclientdetailsboolean

Include the client sub-object on each item.

getadmininfoboolean

Include dateupdated / updated_by fields.

formatstring

Thumbnail size variant.

Allowed values:listtiles
recordsinteger

Page size (0 = no paging).

orderbystring

Sort order.

Allowed values:nonereference_IDreference_ID descdatefromdatefrom descdateuntildateuntil descprojecttitleprojecttitle descsortordermarkerlistsortorderlastviewdatecountersignrequestedrandom

Responses

reference_IDinteger
projecttitlestring
subtitlestring
displayedlocationstring
countrystring
regionstring
citystring
locationstring
latitudenumber
longitudenumber
datestring

Formatted project date/range.

thumbnailstring

CDN URL of the list image.

uniquenamestring
referencedetailpagelinkstring

Public detail page URL on the platform.

seolabelstring
companyobject
statusinteger

Approval status code.

projectstatusinteger
ispublishedboolean
iscountersignedboolean

Client-confirmed (verified) reference.

datecountersignedstring
countersignstatusinteger
isfeaturedboolean
referencetype_IDinteger
datecreatedstring
clientobject

Client info, shaped by the client's display type. Anonymized clients deliver only displayedname; named corporate clients may include address, profile link, and — where allowed — contact person name and job title.

dateupdatedstring

Only with getadmininfo=true.

updated_bystring

Only with getadmininfo=true.