Skip to main content
GET
/
api
/
v1
/
messages
Retrieve messages based on filter criteria with pagination
curl --request GET \
  --url https://notification.platform.dev.ai71services.ai/api/v1/messages \
  --header 'x-api-key: <x-api-key>'
{
  "current_page": 123,
  "messages": [
    {
      "channel": "email",
      "delivery_time": "<string>",
      "message_id": "<string>",
      "organization_id": "<string>",
      "payload": {
        "Organization_id": "<string>",
        "channel": "email",
        "id": "<string>",
        "message": "<string>",
        "priority": "high",
        "product_id": "<string>",
        "recipient": "<string>",
        "retry_enabled": true,
        "sender": "<string>",
        "retry_count": 0,
        "subject": "<string>",
        "template_fields": {
          "message": {
            "from_email": "<string>",
            "from_name": "<string>",
            "merge_language": "<string>",
            "subject": "<string>",
            "to": [
              {
                "email": "<string>",
                "name": "<string>",
                "type": "<string>"
              }
            ],
            "global_merge_vars": [
              {
                "content": {},
                "name": "<string>"
              }
            ]
          },
          "template_content": [
            {}
          ],
          "template_name": "<string>"
        }
      },
      "product_id": "<string>",
      "receiver_id": "<string>",
      "retry_count": 123,
      "sender_id": "<string>",
      "status": "accepted",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "page_size": 123,
  "total_items": 123,
  "total_pages": 123
}

Headers

x-api-key
string
required

API key for authorization

Query Parameters

product_id
string
required

Product ID

organization_id
string

Organization ID

user_id
string

User ID

receiver_id
string

Receiver ID

status
string

Status

created_at
string<date-time>

Creation Date

page
integer
default:1

Page number for pagination

limit
integer
default:10

Number of items per page

Response

OK

current_page
integer
messages
object[]
page_size
integer
total_items
integer
total_pages
integer