# List Messages — Quo

> Retrieve a paginated list of messages from OpenPhone, scoped to a phone number and a participant — both are required by the API. Optionally narrow further to one conversation with conversationId. Example: call with…

- Key: `openphone-list-messages`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Quo (`openphone`) — https://pipedream.com/apps/openphone.md
- This page (HTML): https://pipedream.com/apps/openphone/actions/list-messages
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/openphone/actions/list-messages/list-messages.mjs

## Description

Retrieve a paginated list of messages from OpenPhone, scoped to a phone number and a participant — both are required by the API. Optionally narrow further to one conversation with `conversationId`. Example: call with phoneNumberId="PN123abc", participants=["+15551234567"] → returns up to 10 recent messages between that number and that participant. Use `fields` to return only specific fields per message. [See the documentation](https://www.openphone.com/docs/api-reference/messages/list-messages)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `conversationId` | `string` | No | The ID of the conversation (format CN...). Run the List Conversations action to find conversation IDs (or the List Messages action, which returns each message's conversationId). |
| `phoneNumberId` | `string` | Yes | The OpenPhone phone number ID (format PN...). Run the List Phone Numbers action to find valid IDs. |
| `participants` | `string[]` | Yes | Participant phone number(s) in E.164 format (e.g. +15551234567). Max 10 participants. Required by this endpoint. |
| `userId` | `string` | No | Optional OpenPhone user ID (format US...) to filter by. Run the List Users action to find user IDs. |
| `createdAfter` | `string` | No | Optional ISO 8601 timestamp; only return messages created after this time. |
| `createdBefore` | `string` | No | Optional ISO 8601 timestamp; only return messages created before this time. |
| `maxResults` | `integer` | No | Maximum number of messages to return. Min 1, max 100. Defaults to 10. |
| `pageToken` | `string` | No | Pagination token (nextPageToken from a previous response) to fetch the next page of results. If nextPageToken is present in a response, call this action again with pageToken set to that value to fetch more results. |
| `fields` | `string[]` | No | Optional list of fields to include in each returned record (e.g. ["id", "createdAt"]). When omitted, the full record is returned. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "openphone",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "openphone-list-messages",
  arguments: {
    conversationId: "Conversation ID",
    phoneNumberId: "Phone Number ID",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "openphone-list-messages",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    openphone: { authProvisionId: "apn_xxxxxxx" },
    conversationId: "Conversation ID",
    phoneNumberId: "Phone Number ID",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "openphone-list-messages",
    "configured_props": {
      "openphone": { "authProvisionId": "apn_xxxxxxx" },
      "conversationId": "Conversation ID",
      "phoneNumberId": "Phone Number ID"
    }
  }'
```

---

- App: https://pipedream.com/apps/openphone.md · All apps: https://pipedream.com/apps