Get Message List

GET https://restapi.actonsoftware.com/api/1/message?type={type}

This endpoint will allow you to download a list of messages in the account.

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
Authorization: Header False Required String Insert your generated access token.
("Bearer {access token}")
type Query False Optional String Specify the type of message to return.
("DRAFT", "TEMPLATE", "SENT", "TRIGGERED", "FAILED", "SCHEDULED")
count Query False Optional String Specify the number of elements to fetch.
(Maximum=1000)
offset Query False Optional String Specify the element offset to begin the fetch.
(Default=0)

Response

{
  "count": 2,
  "totalCount": 2,
  "offset": 0,
  "msgresult": [
    {
      "title": "Example",
      "msg_id": "s-0002-1910",
      "time_when": "Mon Oct 7 6:37 PM GMT-12:00",
      "sender_name": "John Doe John Doe",
      "sender_id": "364932",
      "is_text_only": "false",
      "timestamp": 1570516663181,
      "sender_email": "john.doe@act-on.com"
    },
    {
      "title": "Example Email",
      "msg_id": "s-0001-1910",
      "time_when": "Mon Oct 7 11:58 AM GMT-12:00",
      "sender_name": "Kyle Ansted Kyle Ansted",
      "sender_id": "364932",
      "is_text_only": "false",
      "timestamp": 1570492735341,
      "sender_email": "john.doe@act-on.com"
    }
  ],
  "id": 0
}

Code Examples

curl -X GET https://restapi.actonsoftware.com/api/1/message?type=sent -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"