View as Markdown
Quo icon

Quo ACTION

List Messages

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
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Quo account once, then configure and run List Messages from your backend or agent.

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Messages inputs
Property Type Description
conversationId Conversation ID string
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).
Optional
phoneNumberId Phone Number ID string
The OpenPhone phone number ID (format PN...). Run the List Phone Numbers action to find valid IDs.
Required
participants Participants string[]
Participant phone number(s) in E.164 format (e.g. +15551234567). Max 10 participants. Required by this endpoint.
Required
userId User ID string
Optional OpenPhone user ID (format US...) to filter by. Run the List Users action to find user IDs.
Optional
createdAfter Created After string
Optional ISO 8601 timestamp; only return messages created after this time.
Optional
createdBefore Created Before string
Optional ISO 8601 timestamp; only return messages created before this time.
Optional
maxResults Max Results integer
Maximum number of messages to return. Min 1, max 100. Defaults to 10.
Optional
pageToken Page Token string
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.
Optional
fields Fields string[]
Optional list of fields to include in each returned record (e.g. ["id", "createdAt"]). When omitted, the full record is returned.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
openphone-list-messages
Version
0.0.2
App
Quo
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes