List Feedback

get/public/v1/feedback

get/public/v1/feedback

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/feedback' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "f1e2e3d4-b5a6-47c8-9d0e-1f2a3b4c5d6e",
      "reference": "FB-2024-00123",
      "feedback_type": "complaint",
      "status": "new",
      "sentiment": "negative",
      "details": "The participant was unhappy with the support provided",
      "follow_up_details": "Followed up with the participant and resolved the issue",
      "complainant_name": "Jane Smith",
      "complainant_email": "jane.smith@example.com",
      "complainant_phone": "0400000000",
      "subject_name": "John Doe",
      "created_at": "2024-01-15T10:30:00+00:00",
      "updated_at": "2024-01-16T14:00:00+00:00",
      "archived_at": "2024-06-01T00:00:00+00:00",
      "assignee": {
        "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
        "name": "John Doe"
      },
      "form_submission": {
        "id": "s1u2b3m4-i5s6-47s8-9i0o-1n2a3b4c5d6e"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of FeedbackResource

dataobject[]required
▶Show 16 child attributesHide child attributes
- idstringrequired
  Example:f1e2e3d4-b5a6-47c8-9d0e-1f2a3b4c5d6e
- referencestringrequired
  Example:FB-2024-00123
- feedback_typestringrequired
  Example:complaint
- statusstringrequired
  Example:new
- sentimentstring | nullrequired
  Example:negative
- detailsstring | nullrequired
  Example:The participant was unhappy with the support provided
- follow_up_detailsstring | nullrequired
  Example:Followed up with the participant and resolved the issue
- complainant_namestring | nullrequired
  Example:Jane Smith
- complainant_emailstring | nullrequired
  Example:jane.smith@example.com
- complainant_phonestring | nullrequired
  Example:0400000000
- subject_namestring | nullrequired
  Example:John Doe
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstring | nullrequired
  Example:2024-01-16T14:00:00+00:00
- archived_atstring | nullrequired
  Example:2024-06-01T00:00:00+00:00
- assigneeobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:John Doe
- form_submissionobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:s1u2b3m4-i5s6-47s8-9i0o-1n2a3b4c5d6e
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors