Desk's app settings of the customer portal (tickets, help); without them the defaults at version 0 (desk:admin, ADR 0023)
GET /api/desk/v1/portal-config
Module: Desk · operationId: getPortalConfig · Tag: Portal · Auth: access token (Authorization: Bearer <accessToken>)
Responses
- 200 Portal (
application/json)
Fields of the 200 answer:
settings(object, required): Settings of desk's portal appsagentName(string): How agents are named to requesters: full name, first name or „Support“ (one offull,first,support)attachments(object): File limits of requester uploadsallowedMime(array of string): Allowed MIME types of requester uploadsmaxBytes(integer): Maximum size per file in bytesmaxCount(integer): Maximum number of files
companyView(object): Allows the company view; who has it is set on the customer account (customerportal)enabled(boolean): The company view may be granted
forms(array of object): Forms requesters open tickets withkey(string, required): Key of the formlabel(string, required): Name of the form (max length 80)spaceKey(string, required): Space of the ticketstypeKey(string, required): Type of the ticketsdefaultPriority(string): Priority key of the ticketsdescription(string): Description shown with the formfields(array of object): Fields of the formkey(string, required): cf.help(string): Help textlabel(string): Label shown to the requesterrequired(boolean): The requester must fill it
public(object): Opens the form for submissions without sign-inenabled(boolean): Submissions without sign-in are onkey(string, read-only): Generated; names the form in the public URL (not secret)origins(array of string): Sites that may embed the form, like https://www.example.de; * any
help(object): Help area settingsask(boolean): Requesters may ask questions answered from the released articles; missing is on
limits(object): Limits per requesterentriesPerHour(integer): Replies per requester and hourticketsPerDay(integer): New tickets per requester and day
phaseLabels(object): Names for requesters by phase (fallback)platformFeedback(object): Platform feedback targets per kind; only the operator tenant (10639/MBCOM) may enable kindskinds(object): Keys: bug, feature, emergency, account
satisfaction(object): Customer satisfaction: the requester rates a closed ticket once (1–5 stars, optional comment) withindaysafter it was closed (rateCustomerTicket; eventdesk.ticket.rated)days(integer): Days after closing; missing or 0 is 14 (max 90)enabled(boolean): Requesters may rate closed tickets
statusLabels(object): Names for requesters by ":"; the key "forwarded" names forwarding stubs (default „Weitergeleitet“)types(object): Per type key: visible to requesters, fields they see (priority, dueAt, customer, contact, category, startOn, cf.)
platformAvailable(boolean, read-only): This tenant is the operator tenantportalUrl(string, read-only): Address of the tenant's customer portal (from customerportal); missing without oneupdatedAt(string (date-time), read-only): When they were last savedupdatedBy(string, read-only): Login (e-mail) of who last saved themversion(integer): Version of the settings (0: never saved); send it back on change
Example 200 answer:
{
"platformAvailable": false,
"portalUrl": "https://muster-it.connectcloud.example",
"settings": {
"agentName": "full",
"attachments": {
"allowedMime": [
"image/png",
"image/jpeg",
"application/pdf"
],
"maxBytes": 10485760,
"maxCount": 5
},
"companyView": {
"enabled": true
},
"forms": [
{
"defaultPriority": "normal",
"description": "Etwas funktioniert nicht? Beschreiben Sie kurz, was passiert ist.",
"fields": [
{
"help": "z. B. Drucker Empfang",
"key": "cf.betroffenes_system",
"label": "Betroffenes Gerät oder System",
"required": false
}
],
"key": "stoerung",
"label": "Störung melden",
"public": {
"enabled": false
},
"spaceKey": "SUP",
"typeKey": "stoerung"
}
],
"help": {
"ask": true
},
"limits": {
"entriesPerHour": 30,
"ticketsPerDay": 20
},
"phaseLabels": {
"active": "In Bearbeitung",
"done": "Erledigt",
"new": "Eingegangen",
"waiting": "Wartet auf Rückmeldung"
},
"satisfaction": {
"days": 14,
"enabled": true
},
"statusLabels": {},
"types": {
"serviceanfrage": {
"fields": [
"priority",
"category",
"dueAt"
],
"visible": true
},
"stoerung": {
"fields": [
"priority",
"category",
"cf.betroffenes_system"
],
"visible": true
}
}
},
"updatedAt": "2026-10-28T10:15:00Z",
"updatedBy": "elias.gruber@muster-it.example",
"version": 5
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/desk/v1/portal-config' \
-H "Authorization: Bearer $ACCESS_TOKEN"