List Satisfaction Ratings

GET/api/v2/satisfaction_ratings

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the List Satisfaction Ratings action (under Satisfaction Ratings).
Fill in the fields below, then reference the result from later steps as {{listSatisfactionRatings.response.data}}.

Request

Query parameters

pageoneOf

Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.

per_pageinteger

Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

sortstring

Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`

Response

Returns 200 with an object. Read it in later steps with {{listSatisfactionRatings.response.data.<field>}}.

satisfaction_ratingsarray<object>

assignee_idinteger (int64)required

The id of agent assigned to at the time of rating

commentstring

The comment received with this rating, if available

created_atstring (date-time)

The time the satisfaction rating got created

group_idinteger (int64)required

The id of group assigned to at the time of rating

idinteger (int64)

Automatically assigned upon creation

reasonstring

The reason for a bad rating given by the requester in a follow-up question. Satisfaction reasons must be [enabled](https://support.zendesk.com/hc/en-us/articles/4408886173338)

reason_codeinteger

The default reasons the user can select from a list menu for giving a negative rating. See [Reason codes](/api-reference/ticketing/ticket-management/satisfaction_reasons/#reason-codes) in the Satisfaction Reasons API. Can only be set on ratings with a `score` of "bad". Responses don't include this property

reason_idinteger (int64)

id for the reason the user gave a negative rating. Can only be set on ratings with a `score` of "bad". To get a descriptive value for the id, use the [Show Reason for Satisfaction Rating](/api-reference/ticketing/ticket-management/satisfaction_reasons/#show-reason-for-satisfaction-rating) endpoint

requester_idinteger (int64)required

The id of ticket requester submitting the rating

scorestringrequired

The rating "offered", "unoffered", "good" or "bad". For POST requests, only "good" or "bad" are valid

ticket_idinteger (int64)required

The id of ticket being rated

updated_atstring (date-time)

The time the satisfaction rating got updated

urlstring

The API url of this rating

json

{
  "satisfaction_ratings": [
    {
      "assignee_id": 135,
      "created_at": "2011-07-20T22:55:29Z",
      "group_id": 44,
      "id": 35436,
      "requester_id": 7881,
      "score": "good",
      "ticket_id": 208,
      "updated_at": "2011-07-20T22:55:29Z",
      "url": "https://company.zendesk.com/api/v2/satisfaction_ratings/62"
    }
  ]
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?