List Messages

get

Responses

200

OK

application/json

400

Bad Request

application/json

get

/public/v1/notifications/messages

HTTPcURLJavaScriptPython

GET /public/v1/notifications/messages HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {},
        "updated": {},
        "queued": {},
        "discarded": {},
        "sent": {},
        "bounced": {},
        "complained": {},
        "failed": {}
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "batch": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "category": {},
        "account": {},
        "subject": "text",
        "body": "text",
        "attachments": [
          {
            "id": "text",
            "href": "text",
            "name": "text",
            "fileName": "text",
            "fileSize": 1,
            "contentType": "text"
          }
        ]
      },
      "contact": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "blockedReason": "text",
        "email": "text",
        "name": "text",
        "optOuts": [
          {
            "id": "text",
            "description": "text",
            "name": "text",
            "icon": "text",
            "lastUsed": "2025-12-19T05:38:30.527Z"
          }
        ],
        "status": "text",
        "userId": "text",
        "user": {}
      },
      "category": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "description": "text",
        "optOutAllowed": true,
        "status": "text",
        "name": "text",
        "note": "text",
        "deleteAllowed": true,
        "icon": "text",
        "statistics": {
          "month": {
            "bounced": 1,
            "complained": 1,
            "discarded": 1,
            "failed": 1,
            "sent": 1,
            "total": 1
          },
          "today": {
            "bounced": 1,
            "complained": 1,
            "discarded": 1,
            "failed": 1,
            "sent": 1,
            "total": 1
          },
          "week": {
            "bounced": 1,
            "complained": 1,
            "discarded": 1,
            "failed": 1,
            "sent": 1,
            "total": 1
          }
        },
        "lastUsed": "2025-12-19T05:38:30.527Z"
      },
      "account": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "icon": "text",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "text",
        "status": "text",
        "serviceLevel": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "text",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "logo": "text",
            "isDefault": true
          }
        ],
        "eligibility": {
          "client": true,
          "partner": true
        }
      },
      "status": "text",
      "statusReason": "text",
      "subject": "text",
      "body": "text",
      "attachments": [
        {
          "id": "text",
          "href": "text",
          "name": "text",
          "fileName": "text",
          "fileSize": 1,
          "contentType": "text"
        }
      ]
    }
  ]
}