Get message log entries

Credentials

No credentials are documented for this endpoint.

Retrieve a paginated list of message log entries for a seller. Used by bookkeepers to review communication history.

Parameters

Name In Type Required Description
sellerId query string no Filter by seller ID
page query integer no Page number (0-indexed)
limit query integer no Number of items per page (max 500)
field query string no Field to sort by
sort query string no Sort direction
_global query string no Global search filter

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/message-log'

Node.js

const response = await fetch("https://sandbox.payme.io/api/message-log", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/message-log",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/message-log');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — List of message log entries (success)

Field Type Description
data array
data[].id string Message log entry ID
data[].sellerId string Seller ID
data[].sentAt string Timestamp when message was sent
data[].correlationId string Correlation ID for tracking
data[].description string Description of communication
data[].sms object
data[].sms.sentTo string Recipient address (phone number for SMS, email address for email)
data[].sms.content string Message content
data[].email object
data[].email.sentTo string Recipient address (phone number for SMS, email address for email)
data[].email.content string Message content
meta object
meta.total integer Total number of entries
meta.page integer Current page number
meta.limit integer Items per page 
{
  "data": [
    {
      "id": "msg-001",
      "sellerId": "550e8400-e29b-41d4-a716-446655440000",
      "sentAt": "2024-01-15T10:30:00Z",
      "correlationId": "corr-123456",
      "description": "Payment reminder",
      "sms": {
        "sentTo": "0501234567",
        "content": "Reminder: Your invoice #12345 is due tomorrow."
      }
    },
    {
      "id": "msg-002",
      "sellerId": "550e8400-e29b-41d4-a716-446655440000",
      "sentAt": "2024-01-14T09:00:00Z",
      "correlationId": "corr-789012",
      "description": "Monthly report",
      "email": {
        "sentTo": "seller@example.com",
        "content": "Your monthly financial report is ready for review."
      }
    }
  ],
  "meta": {
    "total": 25,
    "page": 0,
    "limit": 10
  }
}

401 — Unauthorized - Invalid or missing authentication (error)

Field Type Description
statusCode integer
message string
error string 
{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}