Get User Canned Responses

Prev Next
Get
/api/v1/canned-responses.get
Premium tag

Get a list of all canned responses in the workspace that belong to the current user scope.

Permission required: view-canned-responses

Changelog

Version Description
1.0.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Responses
200

OK

Success Example
{
  "responses": [
    {
      "_id": "6470086ba8c3a3ba32d0fb1b",
      "shortcut": "department-checking",
      "text": "This is check test for departmental canned response",
      "scope": "global",
      "departmentId": "64181a0728384134ed600dcc",
      "createdBy": {
        "_id": "2tTEqR7ZNMJ4HGGNa",
        "username": "testroxie"
      },
      "_createdAt": "2023-05-26T01:16:27.848Z",
      "_updatedAt": "2023-05-26T01:16:27.848Z"
    },
    {
      "_id": "647009e1a8c3a3ba32d0fb1f",
      "shortcut": "admin-checking",
      "text": "This is check test for departmental canned response",
      "scope": "department",
      "departmentId": "64181a0728384134ed600dcc",
      "createdBy": {
        "_id": "rbAXPnMktTFbNpwtJ",
        "username": "kim.jane"
      },
      "_createdAt": "2023-05-26T01:22:41.104Z",
      "_updatedAt": "2023-05-26T01:22:41.104Z"
    },
    {
      "_id": "647009fba8c3a3ba32d0fb21",
      "shortcut": "admin-checking3",
      "text": "This is check test for departmental canned response",
      "scope": "global",
      "departmentId": "64181a0728384134ed600dcc",
      "createdBy": {
        "_id": "rbAXPnMktTFbNpwtJ",
        "username": "doe.john"
      },
      "_createdAt": "2023-05-26T01:23:07.374Z",
      "_updatedAt": "2023-05-26T01:23:07.374Z"
    }
  ],
  "success": true
}
Expand All
object
responses
Array of object
object
_id
string
shortcut
string
text
string
scope
string
departmentId
string
createdBy
object
_id
string
username
string
_createdAt
string
_updatedAt
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string
Tags