List CSAT feedback (tenant:crm:read)
GET /api/crm/v1/csat
Module: CRM · operationId: listCsatFeedbacks · Tag: CSAT · Auth: access token (Authorization: Bearer <accessToken>)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
query | string (uuid) | Only this feedback (a hit of the global search opens it so). | |
addressId |
query | string (uuid) | Only feedback for this masterdata address. | |
ticketId |
query | string | Only feedback for this ticket. (max length 64) | |
channel |
query | CSATChannel | (one of PORTAL, EMAIL, PHONE, IN_PERSON) |
|
from |
query | string (date-time) | Only feedback created at or after this time (RFC 3339). | |
to |
query | string (date-time) | Only feedback created before this time (RFC 3339). | |
search |
query | string | Case-insensitive substring of comment or submitter. (max length 255) | |
sort |
query | string | Sort order: a field for ascending, -field for descending. Fields: createdAt, rating, channel. Default -createdAt. Unknown values answer 400 (invalid_sort). (max length 32) |
|
limit |
query | integer | Page size, 1–200 (default 50); any other value is 400 invalid. (default 50; max 200) |
|
cursor |
query | string | nextCursor of the previous page; leave out for the first page. Keep sort and the filters unchanged while paging: a cursor of another sort or an altered one is 400 invalid (field: cursor). (max length 1024) |
Responses
- 200 A page of feedback and the total number of matching entries (
application/json) - 400 Invalid input (
invalid):fieldnames the first invalid field,details.fieldsevery one (JSON paths for bodies, parameter names for the query). Some refusals have their own code (invalid_sort,invalid_stages,invalid_custom_fields,convert_target_required,invalid_csv, …). (application/json) - 401 Missing, invalid or expired token (no body).
- 403 The token lacks the permission (
insufficient permissions) or has no active tenant. (application/json) - 500 Unexpected error; details are only logged. (
application/json)
Fields of the 200 answer:
items(array of CSATFeedback, required): One page of feedback.channel(CSATChannel, required): (one ofPORTAL,EMAIL,PHONE,IN_PERSON)createdAt(string (date-time), required): When the feedback was given.customerNo(string, required): Customer number of the tenant.id(string (uuid), required): Id of the feedback.rating(integer, required): Rating from 1 (bad) to 5 (very good). (max 5)tenantName(string, required): Tenant name.addressId(string (uuid)): Omitted when not set.comment(string): Omitted when not set.submittedBy(string): Omitted when not set.ticketId(string): Omitted when not set. For a rating from the customer portal the desk ticket id.ticketNumber(integer (int64)): Number of the desk ticket the customer rated in the portal (desk.ticket.rated); omitted for feedback recorded by hand.
total(integer, required): Number of all records matching the filters.nextCursor(string): Cursor of the next page (pass it ascursor); missing on the last page.
Example 200 answer:
{
"items": [
{
"addressId": "3c5e7a9c-1d3f-4b5a-9c7e-1a3c5e7a9c1e",
"channel": "PORTAL",
"comment": "Schnelle Hilfe, das WLAN im Restaurant läuft wieder stabil.",
"createdAt": "2026-11-17T11:05:00Z",
"customerNo": "99999",
"id": "9f1b3d5f-7a9c-4e1d-8b3f-7e9a1c3e5b7d",
"rating": 5,
"submittedBy": "Katrin Stadler",
"tenantName": "DEMO",
"ticketId": "6a8c0e2a-4b6d-4f8a-9c1e-3b5d7f9a1c3e",
"ticketNumber": 214
}
],
"total": 1
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/crm/v1/csat' \
-H "Authorization: Bearer $ACCESS_TOKEN"