GET/desk/api/v2/cannedresponses.json

Get a paginated list of cannedresponses.

The following values are allowed in the filter query parameter:

  • createdAt
  • createdBy
  • deletedAt
  • deletedBy
  • id
  • inbox
  • name
  • reply
  • state
  • updatedAt
  • updatedBy

The following values are allowed in the orderBy query parameter:

  • createdAt

  • createdBy

  • deletedAt

  • deletedBy

  • id

  • inbox

  • name

  • reply

  • state

  • updatedAt

  • updatedBy

         The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter:

  • files

  • inboxes

  • users

  • all

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    CannedResponsesAPIBody handles request/response for canned response listing
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

CannedResponsesAPIBody
{  "cannedresponses": [    {      "createdAt": "2024-10-18T23:59:26.347Z",      "createdBy": {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"        },        "type": 0      },      "deletedAt": "2024-10-18T23:59:26.347Z",      "deletedBy": {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"
Download Swagger