GET/desk/api/v2/scheduledemails.json

Get a paginated list of scheduledemails.

The following values are allowed in the filter query parameter:

  • id

  • ticket

  • message

  • status

  • title

  • note

  • body

  • sendAt

  • timezone

  • zone

  • createdAt

  • updatedAt

  • deletedAt

  • createdBy

  • updatedBy

  • deletedBy

  • state

    The following values are allowed in the orderBy query parameter:

  • id

  • ticket

  • message

  • status

  • title

  • note

  • body

  • sendAt

  • timezone

  • zone

  • createdAt

  • updatedAt

  • deletedAt

  • createdBy

  • updatedBy

  • deletedBy

  • state

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    ScheduledEmailsAPIBody handles the listing response for scheduledemail.
  • 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

ScheduledEmailsAPIBody
{  "included": {    "addresses": [      {        "city": "string",        "country": "string",        "firstLine": "string",        "id": 0,        "postalCode": "string",        "secondLine": "string",        "state": "string"      }    ],    "agentsnotified": [      {        "autoFollowOnCC": true,        "avatarURL": "string",        "createdAt": "2024-07-26T20:26:10.533Z",