GET api/v2/Notification

Request Information

URI Parameters

Name	Type	Additional information
IdentityKey	globally unique identifier	None.
NotificationId	integer	None.
AccountId	Collection of string	None.
TemplateName	Collection of string	None.
HasBeenSent	boolean	None.
MaxAgeDays	integer	None.
Limit	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of APINotification

Name	Type	Additional information
IdentityKey	globally unique identifier	None.
AccountId	string	None.
ActionId	integer	None.
PortalSource	string	None.
ActionType	string	None.
DueOn	date	None.
NotificationId	integer	None.
TemplateName	string	None.
AttachmentFileId	globally unique identifier	None.
CreatedOn	date	None.
SentOn	date	None.
Address	string	None.
Subject	string	None.
ContentHTML	string	None.
ContentPlain	string	None.
Parameters	Dictionary of string [key] and Object [value]	None.
FailureResponse	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "IdentityKey": "b8f6381e-15c3-4c98-9e4e-2a924c3a513d",
    "AccountId": "sample string 1",
    "ActionId": 1,
    "PortalSource": "sample string 2",
    "ActionType": "sample string 3",
    "DueOn": "2026-04-04T11:30:44.3507897Z",
    "NotificationId": 4,
    "TemplateName": "sample string 5",
    "AttachmentFileId": "302ccbf8-4c4d-459d-9a11-eb91a6c576d6",
    "CreatedOn": "2026-04-04T11:30:44.3507897Z",
    "SentOn": "2026-04-04T11:30:44.3507897Z",
    "Address": "sample string 7",
    "Subject": "sample string 8",
    "ContentHTML": "sample string 9",
    "ContentPlain": "sample string 10",
    "Parameters": {},
    "FailureResponse": "sample string 11"
  },
  {
    "IdentityKey": "b8f6381e-15c3-4c98-9e4e-2a924c3a513d",
    "AccountId": "sample string 1",
    "ActionId": 1,
    "PortalSource": "sample string 2",
    "ActionType": "sample string 3",
    "DueOn": "2026-04-04T11:30:44.3507897Z",
    "NotificationId": 4,
    "TemplateName": "sample string 5",
    "AttachmentFileId": "302ccbf8-4c4d-459d-9a11-eb91a6c576d6",
    "CreatedOn": "2026-04-04T11:30:44.3507897Z",
    "SentOn": "2026-04-04T11:30:44.3507897Z",
    "Address": "sample string 7",
    "Subject": "sample string 8",
    "ContentHTML": "sample string 9",
    "ContentPlain": "sample string 10",
    "Parameters": {},
    "FailureResponse": "sample string 11"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAPINotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lilaham.TaxIdPOC.Models.API">
  <APINotification>
    <AccountId>sample string 1</AccountId>
    <ActionId>1</ActionId>
    <ActionType>sample string 3</ActionType>
    <Address>sample string 7</Address>
    <AttachmentFileId>302ccbf8-4c4d-459d-9a11-eb91a6c576d6</AttachmentFileId>
    <ContentHTML>sample string 9</ContentHTML>
    <ContentPlain>sample string 10</ContentPlain>
    <CreatedOn>2026-04-04T11:30:44.3507897+00:00</CreatedOn>
    <DueOn>2026-04-04T11:30:44.3507897+00:00</DueOn>
    <FailureResponse>sample string 11</FailureResponse>
    <IdentityKey>b8f6381e-15c3-4c98-9e4e-2a924c3a513d</IdentityKey>
    <NotificationId>4</NotificationId>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <PortalSource>sample string 2</PortalSource>
    <SentOn>2026-04-04T11:30:44.3507897+00:00</SentOn>
    <Subject>sample string 8</Subject>
    <TemplateName>sample string 5</TemplateName>
  </APINotification>
  <APINotification>
    <AccountId>sample string 1</AccountId>
    <ActionId>1</ActionId>
    <ActionType>sample string 3</ActionType>
    <Address>sample string 7</Address>
    <AttachmentFileId>302ccbf8-4c4d-459d-9a11-eb91a6c576d6</AttachmentFileId>
    <ContentHTML>sample string 9</ContentHTML>
    <ContentPlain>sample string 10</ContentPlain>
    <CreatedOn>2026-04-04T11:30:44.3507897+00:00</CreatedOn>
    <DueOn>2026-04-04T11:30:44.3507897+00:00</DueOn>
    <FailureResponse>sample string 11</FailureResponse>
    <IdentityKey>b8f6381e-15c3-4c98-9e4e-2a924c3a513d</IdentityKey>
    <NotificationId>4</NotificationId>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <PortalSource>sample string 2</PortalSource>
    <SentOn>2026-04-04T11:30:44.3507897+00:00</SentOn>
    <Subject>sample string 8</Subject>
    <TemplateName>sample string 5</TemplateName>
  </APINotification>
</ArrayOfAPINotification>