Messages

Search for emails

Search for email in your workspace using advanced filters. Supports filtering by email properties including ID, recipient, sender, status, type, subject, dates, and related entities (study, panel, participant, campaigns, teams, populations). Filters can be combined using AND/OR logic operators for complex queries.

Required permissions:

  • View emails
  • Access All People directory
post/messages/emails/search

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/messages/emails/search
  • Auth: HTTP bearer

Request body

studyIdstring

Filter messages by study ID

teamIdstring

Filter messages by team ID

userIdstring

Filter messages by sender user ID

populationIdstring

Filter messages by population ID

Example request

{
  "filter": {
    "operator": "AND",
    "filters": [
      {
        "message": {
          "propertyType": "SINGLE_SELECT",
          "propertyName": "EMAIL_STATUS",
          "operator": "IS",
          "value": "DELIVERED"
        }
      },
      {
        "message": {
          "propertyType": "DATETIME",
          "propertyName": "SENT_AT",
          "operator": "IS_WITHIN",
          "value": "NUMBER_OF_DAYS_AGO",
          "amount": 7
        }
      },
      {
        "person": {
          "propertyType": "STRING",
          "propertyName": "EMAIL",
          "operator": "CONTAINS",
          "value": "@example.com"
        }
      }
    ]
  },
  "pageInfo": {
    "size": 10
  }
}

Response

Successfully retrieved emails

totalnumber required

The total number of items in your workspaces based on your search parameters

Changes

No recorded changes to this operation across all 1 revision of this API.