PipeRun API icon

PipeRun API

Interact with the PipeRun CRM API.

Actions220

Emails → Listar E Mails

AI-generated

Summary

Lists PipeRun emails, with optional pagination and filters for the linked user, company, person, deal, template, status, type, and creation or update dates. Sends these values as query parameters to the PipeRun API.

Inputs

  • Show — Number of items per result page.
  • Cursor — Page number.
  • User Id — Filter by the ID of the user linked to the email.
  • Company Id — Filter by company ID.
  • Person Id — Filter by person ID.
  • Deal Id — Filter by opportunity ID.
  • Email Template Id — Filter by email template ID.
  • Status — Filter by email status: 1 = unread, 2 = read, 3 = sent, 4 = send failed.
  • Type — Filter by email type: 0 = received, 1 = sent, 2 = draft, 3 = archived.
  • Created At Start — Filter for emails created from this date and time.
  • Created At End — Filter for emails created up to this date and time.
  • Updated At Start — Filter for emails created from this date and time, as described in the field.
  • Updated At End — Filter for emails updated from this date and time.
  • Custom Query Parameters — Add query parameter key/value pairs to the request.
  • Custom Query (JSON) — Provide a JSON object of additional query parameters; invalid JSON raises an error.

Output shape

A list of email records returned by the PipeRun API.

The operation uses the required PipeRun API credentials. Exact response fields and pagination response format are not specified in the provided source.

Examples

Example 1: Retrieve emails for a specific person

Set Person Id to the person’s ID; optionally set Show and Cursor to control the requested page.

Links

Discussion