Get Emails that are associated with a Domain Record

get

https://{environment}.origamirisk.com/OrigamiApi/api/{domain}/{id}/Emails

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Use this to retrieve the email history of a particular domain record (such as a Claim, Policy, Incident, etc).

Supports pagination and advanced filtering.

Path Params

domain

string

required

This should match to the Domain Name in the system. It is case-sensitive. For Client Defined Entities it should start with "Custom.".

integer

required

This is the primary identifier for the parent record. For example, if my {domain} is Claim and my {id} is 1234, then I will retrieve emails assocated with Claim 1234.

Query Params

columns

string

required

Defaults to EmailID, ParentID, Body, Subject, Status, SendDate

A comma separated list of the columns you want returned to you in the response. Useful columns may include:

EmailID, ParentID, Body, Subject, Status, SendDate

filter

string

Filter criteria using Origami Advanced Search syntax.

⚠️ Filtering behavior for Status is intentionally constrained. Draft emails (Status=D) will always be excluded, even when no filter is provided or when intentionally included via a status filter (ie: ?filter=Status:eq:D).

sort

string

Columns to sort by. Similar syntax to sorting in Views.

startAt

integer

Defaults to 0

Default is 0. If you are fetching subsequent pages of data indicate the record to start with.

take

integer

Defaults to 30

If you do not provide a value for take, the default is 30 records. The maximum allowed is configured per client and, while adjustable, it rarely exceeds 100.

LINQFilter

string

Optional record filter criteria in C# LINQ syntax. Only to be used in cases where filter syntax does not meet needs.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200