# referenzen.com Documentation

## Documentation

- [Introduction](https://docs.referencedeck.com/getting-started/introduction.md): What referenzen.com and referencedeck.com are, who they are for, and how the platform is organized.
- [Quickstart](https://docs.referencedeck.com/getting-started/quickstart.md): Create a company account, set up your profile, and publish your first reference in about 30 minutes.
- [Core Concepts](https://docs.referencedeck.com/getting-started/core-concepts.md): The building blocks of the platform — references, branches, work fields, services, properties, release levels, channels, and roles.
- [Accounts & Login](https://docs.referencedeck.com/getting-started/account-and-login.md): Registration, e-mail confirmation, login, Microsoft single sign-on, password reset, invitations, and personal settings.
- [Your Workspace](https://docs.referencedeck.com/getting-started/workspace.md): A tour of the logged-in workspace — navigation, the dashboard, and how the pieces fit together.
- [The Reference Manager](https://docs.referencedeck.com/references/reference-manager.md): Find, filter, and organize your company's references — list, tile, and map views, faceted filters, and bulk actions.
- [Creating & Editing References](https://docs.referencedeck.com/references/creating-and-editing.md): The reference form — its tabs, multilingual editing with translation mode, and the basic data of a project.
- [Services & Project Properties](https://docs.referencedeck.com/references/services-and-properties.md): Describe projects in a structured, industry-specific way — work fields, services, and typed properties that power the search filters.
- [Media & Uploads](https://docs.referencedeck.com/references/media.md): Images, stage media, 360° panoramas, videos, documents, and audio — and how to control their visibility.
- [Publishing References](https://docs.referencedeck.com/references/publishing.md): The approval workflow, per-language statuses, publication channels, release levels, and reviewer notifications.
- [Client Confirmations](https://docs.referencedeck.com/references/client-confirmations.md): Invite clients to confirm your references online — verified references carry a badge and can include client quotes.
- [Clients & Contact Persons](https://docs.referencedeck.com/references/clients.md): Manage the clients your projects were delivered for, their contact persons, and how clients appear on public reference pages.
- [Reference Groups](https://docs.referencedeck.com/references/reference-groups.md): Organize references in your own hierarchical structure — business units, regions, campaigns — independent of the industry tree.
- [Products, Partners & Awards](https://docs.referencedeck.com/references/products-partners-awards.md): Enrich references with the products you deployed, the partners you worked with, and the awards a project won.
- [Export, Print & Import](https://docs.referencedeck.com/references/export-and-import.md): Export references as PDF, Excel, or PowerPoint, print catalogs, compare references, and import existing data.
- [The Public Company Profile](https://docs.referencedeck.com/company/company-profile.md): What visitors see on your company page, how it is structured, and where each section is managed.
- [Master Data](https://docs.referencedeck.com/company/master-data.md): Company name, industries, URL slug, contact data, logo, and the publication status of your profile.
- [About Us & Imprint](https://docs.referencedeck.com/company/about-us.md): Your company description, key facts, legally required imprint information, and social media links.
- [Profile Sections](https://docs.referencedeck.com/company/profile-sections.md): The optional sections of your public profile — locations, services & methods, media library, history, news, and job offers.
- [Team & Permissions](https://docs.referencedeck.com/company/team-and-permissions.md): Add team members, assign roles and permissions, manage seats, and set up the approval chain.
- [Branch Settings & Custom Fields](https://docs.referencedeck.com/company/branch-settings.md): Tailor the industry-specific reference forms to your company — hide unused fields, reorder sections, and add your own custom fields.
- [Plan, Billing & Vouchers](https://docs.referencedeck.com/company/plan-and-billing.md): Your subscription plan, usage contingents, invoices, upgrades, and voucher redemption.
- [Search](https://docs.referencedeck.com/discovery/search.md): Find references and companies platform-wide — full-text search, faceted filters, result views, and exports.
- [Industries (Branches)](https://docs.referencedeck.com/discovery/branches.md): The industry tree, public industry pages, suggesting new industries, and the branch expert program.
- [Watchlists](https://docs.referencedeck.com/discovery/watchlists.md): Collect references and companies in personal or shared lists, annotate them, and share them internally or publicly.
- [Messages & Inquiries](https://docs.referencedeck.com/discovery/messages.md): The built-in inbox — conversations with other companies, inquiries from your public profile, invitations, and system notifications.
- [Statistics](https://docs.referencedeck.com/discovery/statistics.md): Measure how your references and profile perform — views over time, top references, channel breakdowns, and CSV export.
- [Digital Signage](https://docs.referencedeck.com/channels/digital-signage.md): Show your references and media on office and showroom screens — screens, playlists, and the content library.
- [AI Access (MCP Gateway)](https://docs.referencedeck.com/channels/ai-mcp-gateway.md): Connect your own AI assistants to your reference data — token management, scopes, usage monitoring, and client setup.
- [Website Embedding](https://docs.referencedeck.com/channels/website-embedding.md): Bring your references to your own website and intranet — via the REST API, the catalog widget, or the hosted showcase.

## API Reference

- [API Introduction](https://docs.referencedeck.com/api-reference/overview.md): The public REST API for displaying your published references on your own website or intranet.
- [Authentication](https://docs.referencedeck.com/api-reference/authentication.md): How API keys work, where to find yours, and how requests are scoped to your company.
- [Building a Reference Catalog](https://docs.referencedeck.com/api-reference/embedding-guide.md): A practical recipe for embedding a filterable reference catalog on a company website with the REST API.
- [List published references](https://docs.referencedeck.com/api-reference/get-references-referenceprojects.md): 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)

- [Get a single reference](https://docs.referencedeck.com/api-reference/get-references-referenceproject.md): 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).

- [Search references](https://docs.referencedeck.com/api-reference/get-references-search.md): 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](#tag/References/operation/getReferenceFilters) 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.

- [Get filter definitions](https://docs.referencedeck.com/api-reference/get-references-filters.md): Returns the filter definitions (facets) available for the company's catalog —
ready to render as a filter sidebar. Each definition names the query parameter to
use with the search endpoint (`name`), a localized `label`, the suggested widget
(`formtype`), and its options with hit counts.

Always included: `sinceyear`, `referencetype_ID`, `mediatype`, `selection`.
Included when data exists: `city`, `workfield_ID`, `method_ID`, `product_ID`,
and one `f{fieldId}` definition per filterable project property.

- [List the company's industries](https://docs.referencedeck.com/api-reference/get-branches-branches.md): Returns the industry branches that the company's published references belong to,
with a reference count per branch. `lft`/`rgt` are nested-set bounds: branch B is
a descendant of branch A when `A.lft < B.lft` and `B.rgt < A.rgt` — use them to
rebuild the tree client-side.

- [Get widget/app settings](https://docs.referencedeck.com/api-reference/get-apps-settings.md): Returns the stored configuration of a registered app/widget instance (e.g. the
reference catalog widget) identified by its UUID. The settings shape depends on
the app type.

- [Bulk export (Excel/JSON)](https://docs.referencedeck.com/api-reference/get-references-export.md): 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.


## Help Center

- [Help Center](https://docs.referencedeck.com/help-center.md): Answers to frequent questions, solutions for common issues, and ways to reach support.
- [General Questions](https://docs.referencedeck.com/help-center/faq/general.md): Frequently asked questions about accounts, languages, plans, and privacy.
- [References & Publishing](https://docs.referencedeck.com/help-center/faq/references.md): Frequently asked questions about creating, publishing, and troubleshooting references.
- [Common Issues](https://docs.referencedeck.com/help-center/troubleshooting/common-issues.md): Solutions for login problems, missing e-mails, permission errors, and other everyday hiccups.

## Changelog

- [Changelog](https://docs.referencedeck.com/changelog.md): Product updates and improvements to the referencedeck.com / referenzen.com platform.