> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pinnacle.sh/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server.

# List Messages

POST https://api.pinnacle.sh/messages/list
Content-Type: application/json

List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.

Reference: https://docs.pinnacle.sh/api-reference/messages/list

## Authentication

- `PINNACLE-API-KEY` header (required) — API Key authentication via header

## Request

### Body (application/json)

This endpoint expects a ListMessagesRequest.

- `pageIndex` (integer, optional, default: 0)
- `pageSize` (integer, optional, default: 20)
- `direction` (enum, optional)
  - Allowed values: `INBOUND`, `OUTBOUND`
- `status` (enum, optional)
  - Allowed values: `PENDING`, `SENT`, `SEND_FAILED`, `DELIVERED`, `DELIVERY_FAILED`, `RECEIVED`, `READ`, `QUEUED`, `FALLBACK_SENT`
- `type` (enum, optional)
  - Allowed values: `SMS`, `MMS`, `RCS`
- `method` (enum, optional) — Filter by the method used to send the message.
  - Allowed values: `API`, `SDK`, `OTHER`
- `from` (string, optional) — Filter by sender phone number (E.164 format) or agent id.
- `to` (string, optional) — Filter by recipient phone number (E.164 format).
- `content` (string, optional) — Search message content (partial match, case-insensitive).
- `dateFrom` (string, optional) — Filter messages created on or after this date (ISO 8601 format).
- `dateTo` (string, optional) — Filter messages created on or before this date (ISO 8601 format).

## Response

### 200

Returns paginated list of messages.

- `data` (list of MessageSummary, required)
- `hasMore` (boolean, required)
- `count` (integer, required)

## Errors

### 400 Bad Request Error

Validation failed. The payload has missing required fields and/or invalid types.  See [https://zod.dev/error-formatting](https://zod.dev/error-formatting) for more information.

- `description` (string, required) — Human-readable summary of validation failures.
- `errors` (ZodErrorErrors, required) — Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### 401 Unauthorized Error

The request lacks valid authentication credentials or the provided credentials are invalid.  Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 500 Internal Server Error

An unexpected error occurred on Pinnacle's servers while processing your request.  If this error persists, please contact support with the request details.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

## Types

### MessageSummary

- `id` (string, required) — Unique identifier for the message.
- `status` (enum, required) — Current status of the message.
  - Allowed values: `PENDING`, `SENT`, `SEND_FAILED`, `DELIVERED`, `DELIVERY_FAILED`, `RECEIVED`, `READ`, `QUEUED`, `FALLBACK_SENT`
- `direction` (enum, required) — Direction of the message.
  - Allowed values: `INBOUND`, `OUTBOUND`
- `type` (enum, required) — Protocol type of the message.
  - Allowed values: `SMS`, `MMS`, `RCS`
- `method` (enum, required) — Method used to send the message.
  - Allowed values: `API`, `SDK`, `OTHER`
- `numSegments` (integer, required) — Number of segments in the message.
- `cost` (double, required, nullable) — Cost of the message.
- `from` (string, required, nullable) — Sender phone number (E.164) or RCS agent ID.
- `to` (string, required, nullable) — Recipient phone number in E.164 format.
- `content` (MessageSummaryContent, required) — Message content (SMS text, MMS media, or RCS rich content).
- `error` (MessageSummaryError, required, nullable) — Error details if the message failed.
- `isTest` (boolean, required) — Whether this is a test message.
- `blastId` (string, required, nullable) — ID of the blast this message belongs to, if any.
- `sentAt` (string, required, nullable) — ISO 8601 timestamp of when the message was sent.
- `deliveredAt` (string, required, nullable) — ISO 8601 timestamp of when the message was delivered.
- `createdAt` (string, required) — ISO 8601 timestamp of when the message was created.
- `updatedAt` (string, required) — ISO 8601 timestamp of when the message was last updated.

### ZodErrorErrors

Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### MessageSummaryContent

Message content (SMS text, MMS media, or RCS rich content).

### MessageSummaryError

Error details if the message failed.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "data": [
    {
      "id": "msg_abc123",
      "status": "DELIVERED",
      "direction": "OUTBOUND",
      "type": "SMS",
      "method": "API",
      "numSegments": 1,
      "cost": 0.0079,
      "from": "+12125551234",
      "to": "+14155556789",
      "content": {
        "text": "Your order has shipped!"
      },
      "error": null,
      "isTest": false,
      "blastId": null,
      "sentAt": "2025-01-15T10:30:01Z",
      "deliveredAt": "2025-01-15T10:30:03Z",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:03Z"
    }
  ],
  "hasMore": true,
  "count": 156
}
```

**SDK Code**

```python List Messages
import requests

url = "https://api.pinnacle.sh/messages/list"

payload = {}
headers = {
    "PINNACLE-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript List Messages
const url = 'https://api.pinnacle.sh/messages/list';
const options = {
  method: 'POST',
  headers: {'PINNACLE-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go List Messages
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinnacle.sh/messages/list"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("PINNACLE-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby List Messages
require 'uri'
require 'net/http'

url = URI("https://api.pinnacle.sh/messages/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["PINNACLE-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java List Messages
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.pinnacle.sh/messages/list")
  .header("PINNACLE-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php List Messages
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.pinnacle.sh/messages/list', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PINNACLE-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp List Messages
using RestSharp;

var client = new RestClient("https://api.pinnacle.sh/messages/list");
var request = new RestRequest(Method.POST);
request.AddHeader("PINNACLE-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift List Messages
import Foundation

let headers = [
  "PINNACLE-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/messages/list")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```