ITiterable
users

Get messages sent to a user

Gets messages sent to a user, by <code>email</code> address or <code>userId</code>. Returns 10 by default, up to 1,000.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.<br/><br/><b>Rate limit</b>: 3 requests/second, per project.

get/api/users/getSentMessages

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Query parameters

emailstring

user's email, either email or userId must be specified

userIdstring

user's userId, either email or userId must be specified

limitinteger

max number of messages to return (default: 10, max limit: 1000)

campaignIdsobject[]

only include messages from these campaigns

startDateTimestring date-time

start date time (yyyy-MM-dd HH:mm:ss ZZ)

endDateTimestring date-time

end date time (yyyy-MM-dd HH:mm:ss ZZ)

excludeBlastCampaignsboolean

exclude results coming from blast campaigns (ignored if campaignId is set)

messageMedium'Email' | 'Push' | 'InApp' | 'SMS'

only include messages of this type

Response

successful operation

Changes

No recorded changes to this operation across all 4 revisions of this API.