---
updatedAt: 2026-07-06T16:34:39.000Z
agentTools:
  projectIndex: https://developers.gorgias.com/llms.txt
---

# The SatisfactionSurvey object

Satisfaction surveys are one of the best ways to determine how well your team is supporting your customers. Find out more about how to use them here: <https://docs.gorgias.com/survey/customer-satisfaction-survey>

Currently there can be only one satisfaction survey per ticket.

# SatisfactionSurvey properties

<div class="rm-ParamContainer">
<form class="rjsf">
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">id</label>
<div class="custom-field-type">integer</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>ID of the survey.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">body_text</label>
<div class="custom-field-type">string | null</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>The comment sent by the customer.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">created_datetime</label>
<div class="custom-field-type">ISO 8601 datetime</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>When the survey was created.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">customer_id</label>
<div class="custom-field-type">integer</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>The ID of the customer who filled the survey.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">meta</label>
<div class="custom-field-type">object | null</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>Data associated with the satisfaction survey. You can use this parameter to store structured information (key-value data) about the satisfaction survey. This field is not used by Gorgias.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">score</label>
<div class="custom-field-type">integer | null</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>The level of satisfaction. Scores range from 1 to 5.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">scored_datetime</label>
<div class="custom-field-type">ISO 8601 datetime</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>When the survey was filled by the customer.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">sent_datetime</label>
<div class="custom-field-type">ISO 8601 datetime</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>When the survey was sent. If is not set it means that it was not sent yet.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">should_send_datetime</label>
<div class="custom-field-type">ISO 8601 datetime</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>When the survey should be sent. If not set then the survey will not be sent by Gorgias.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">ticket_id</label>
<div class="custom-field-type">integer</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>The ID of the ticket the survey is associated with.</p></div>
</div>
</div>
<div class="form-group field custom-field">
<div class="custom-field-row">
<label class="custom-field-name">uri</label>
<div class="custom-field-type">string</div>
</div>
<div class="custom-field-description-container">
<div class="field-description markdown-body"><p>URI of the survey.</p></div>
</div>
</div>
</form>
</div>

<style>
.custom-field {
    padding: 10px;
}
.custom-field:not(:first-child) {
    border-top: 1px solid rgba(0,0,0,0.1);
}
.custom-field-row {
    align-items: baseline;
    display: flex;
    flex-wrap: nowrap;
}
.custom-field-name {
    font-size: 14px;
    font-weight: var(--font-weight-bold);
    color: var(--color-text-default);
    margin-right: 5px;
}
.custom-field-type {
    font-size: 12px;
    color: var(--color-text-minimum);
    margin-right: 5px;
}
.custom-field-deprecated {
    border-radius: var(--border-radius-lg);
    box-shadow: var(--box-shadow-pill);
    color: #fff;
    display: inline-flex;
    font-size: 8px;
    font-weight: var(--font-weight-bold);
    height: 16px;
    line-height: 16px;
    padding-left: 5px;
    padding-right: 5px;
    text-transform: uppercase;
    background: #939eae;
    text-shadow: 1px 1px 0 #8a96a7,0 1px 0 #8a96a7,1px 0 0 #8a96a7;
}
.custom-field-description-container {
    margin-top: 5px;
}
</style>

# SatisfactionSurvey example object

```json
{
  "id": 1234,
  "body_text": "Such speed, much pertinent.",
  "created_datetime": "2019-11-16T15:59:41.966927",
  "customer_id": 120,
  "meta": {
    "externalData": {
      "id": 1234
    }
  },
  "score": 2,
  "scored_datetime": "2019-11-25T15:59:41.966927",
  "sent_datetime": "2019-11-23T15:59:41.966927",
  "should_send_datetime": "2019-11-23T15:59:41.966927",
  "ticket_id": 12
}
```