Help Center

16 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

Get enabled module keys for a space#

GET/help-center/space-modulesToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`Pflicht	Query	`string`	Space UUID

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/space-modules" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List spaces the current user belongs to#

GET/help-center/spacesToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/spaces" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List the current user's support requests#

GET/help-center/support-requestsToken

Parameter

Name	Ort	Typ	Beschreibung
`status`	Query	`string`	Filter by ticket status Werte: `openin_progressresolvedclosed`
`spaceId`	Query	`string`	Filter by space UUID
`page`	Query	`number`	–
`limit`	Query	`number`	–
`search`	Query	`string`	Search subject text or an exact ticket number
`taskStatusId`	Query	`string`	Filter by the linked task status UUID
`priority`	Query	`string`	Legacy bucket filter (low\|medium\|high\|critical) Werte: `lowmediumhighcritical`
`priorityId`	Query	`string`	Filter by a configurable priority UUID. Rows saved before this column existed are matched by their legacy bucket.
`requestType`	Query	`string`	Human-readable request type label configured in the form builder
`scope`	Query	`string`	'mine' = created by the caller, 'shared' = shared with the caller, 'all' = either Werte: `minesharedall`
`createdFrom`	Query	`string`	ISO-8601 lower bound on created_at
`createdTo`	Query	`string`	ISO-8601 upper bound on created_at
`sortBy`	Query	`string`	Werte: `created_atupdated_atticket_numbersubject`
`sortDir`	Query	`string`	Werte: `ascdesc`

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/support-requests" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a new support request#

POST/help-center/support-requestsToken

Request-Body`application/jsonCreateSupportRequestDto`

Name	Typ	Beschreibung
`subject`Pflicht	`string`	Short title of the issue
`category`Pflicht	`string`	Werte: `technicalfeature_requestbuggeneral`
`priority`	`string`	Legacy priority key (low\|medium\|high\|critical). Prefer priority_id. Werte: `lowmediumhighcritical`
`priority_id`	`string`	Configurable priority UUID (from /task-priorities)
`description`Pflicht	`string`	Full description of the issue (10–10 000 chars)
`module_affected`	`string`	XiSuite module key affected (e.g. tasks, boards)
`spaceId`	`string`	Space UUID this ticket belongs to
`status`	`string`	Werte: `openin_progressresolvedclosed` Standard: `"open"`
`request_type`	`string`	Human-readable request type label configured in the form builder
`custom_field_values`	`object`	Custom field answers keyed by custom_fields.field_key

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/help-center/support-requests" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject":"…","category":"technical","description":"…"}'

Get a single support request by ID#

GET/help-center/support-requests/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Combined reply / comment / status-change timeline for a support request#

GET/help-center/support-requests/{id}/activityToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/activity" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Add a customer-portal comment#

POST/help-center/support-requests/{id}/commentsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonAddSupportRequestCommentDto`

Name	Typ	Beschreibung
`content`Pflicht	`string`	Comment body (1-10000 chars)

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/comments" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"…"}'

Forms staff have asked the customer to fill#

GET/help-center/support-requests/{id}/form-requestsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/form-requests" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Submit a pending staff-requested form#

POST/help-center/support-requests/{id}/form-requests/{frId}/submitToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`frId`Pflicht	Pfad	`string`	–

Request-Body`application/jsonSubmitFormRequestDto`

Name	Typ	Beschreibung
`data`Pflicht	`object`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/form-requests/{frId}/submit" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"data":{}}'

Staff replies published for a support request#

GET/help-center/support-requests/{id}/repliesToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/replies" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List creator + shared users for a support request#

GET/help-center/support-requests/{id}/sharesToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/shares" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Share a support request by email. Always 204 — never confirms whether the email has an account#

POST/help-center/support-requests/{id}/sharesToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonShareSupportRequestDto`

Name	Typ	Beschreibung
`email`Pflicht	`string`	Email address to share this ticket with

Antworten

204Kein Inhalt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/shares" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"…"}'

Remove a shared user (creator, or self-removal)#

DELETE/help-center/support-requests/{id}/shares/{userId}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`userId`Pflicht	Pfad	`string`	–

Antworten

204Kein Inhalt

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/shares/{userId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

POST /help-center/support-requests/{id}/task#

POST/help-center/support-requests/{id}/taskToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/task" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Status transitions the published ticket-list block lets the customer make#

GET/help-center/support-requests/{id}/transitionsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`funnelId`Pflicht	Query	`string (uuid)`	–
`pageId`Pflicht	Query	`string (uuid)`	–
`elementId`Pflicht	Query	`string (uuid)`	–

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/transitions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Execute an offered status transition; returns the updated request#

POST/help-center/support-requests/{id}/transitionsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonExecuteSupportRequestTransitionDto`

Name	Typ	Beschreibung
`funnelId`Pflicht	`string (uuid)`	–
`pageId`Pflicht	`string (uuid)`	–
`elementId`Pflicht	`string (uuid)`	–
`transitionId`Pflicht	`string (uuid)`	–
`expectedVersion`	`number`	Task version for optimistic locking

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/help-center/support-requests/{id}/transitions" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"funnelId":"…","pageId":"…","elementId":"…","transitionId":"…"}'

Help Center

Get enabled module keys for a space#

Parameter

Antworten

List spaces the current user belongs to#

Antworten

List the current user's support requests#

Parameter

Antworten

Create a new support request#

Request-Bodyapplication/jsonCreateSupportRequestDto

Antworten

Get a single support request by ID#

Parameter

Antworten

Combined reply / comment / status-change timeline for a support request#

Parameter

Antworten

Add a customer-portal comment#

Parameter

Request-Bodyapplication/jsonAddSupportRequestCommentDto

Antworten

Forms staff have asked the customer to fill#

Parameter

Antworten

Submit a pending staff-requested form#

Parameter

Request-Bodyapplication/jsonSubmitFormRequestDto

Antworten

Staff replies published for a support request#

Parameter

Antworten

List creator + shared users for a support request#

Parameter

Antworten

Share a support request by email. Always 204 — never confirms whether the email has an account#

Parameter

Request-Bodyapplication/jsonShareSupportRequestDto

Antworten

Remove a shared user (creator, or self-removal)#

Parameter

Antworten

POST /help-center/support-requests/{id}/task#

Parameter

Antworten

Status transitions the published ticket-list block lets the customer make#

Parameter

Antworten

Execute an offered status transition; returns the updated request#

Parameter

Request-Bodyapplication/jsonExecuteSupportRequestTransitionDto

Antworten

Request-Body`application/jsonCreateSupportRequestDto`

Request-Body`application/jsonAddSupportRequestCommentDto`

Request-Body`application/jsonSubmitFormRequestDto`

Request-Body`application/jsonShareSupportRequestDto`

Request-Body`application/jsonExecuteSupportRequestTransitionDto`