List pending emails

GET 
/v2/pending_emails

Fetches a list of emails ready to be sent by an external email service. Only emails sent with an External Email Client will appear here.

Request

Query Parameters

per_page integer

How many records to show per page in the range [1, 100]. Defaults to 25

page integer

The current page to fetch results from. Defaults to 1

include_paging_counts boolean

Whether to include total_pages and total_count in the metadata. Defaults to false

limit_paging_counts boolean

Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

Responses

200

Success

application/json

Schema

Schema

id integer

ID of the email

mailbox string

Email Address of the pending email

mime_email_payload object
The email MIME payload
id integer
_href string

Example (from schema)

{
  "id": 1,
  "mailbox": "example@salesloft.com",
  "mime_email_payload": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/mime_email_payloads/1"
  }
}

Loading...