GET api/Configuration/EventSubscriptions/Client/{clientId}
Allows a user to get the event subscriptions for the client they specify.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
The client id. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The list of event subscriptions.
Collection of ESignSystems.SmartSAFE.Models.EventNotification.EventSubscriptionModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientEventSubscriptionId |
Gets or sets the identifier of the event subscription. |
integer |
None. |
| ClientId |
Gets or sets the event subscription's client identifier. |
integer |
None. |
| EventTypeId |
Gets or sets the event type of the subscription. |
integer |
None. |
| EventType |
Gets or sets the event subscription's event type. |
string |
None. |
| EmailNotification |
Gets or sets a value indicating whether the client wants to receive notification emails. |
boolean |
Required |
| FromEmailAddress |
Gets or sets the from address for the notification email. |
string |
Data type: EmailAddress Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]+ Max length: 256 |
| FromEmailName |
Gets or sets the name of the from address for the notification email. |
string |
Max length: 256 |
| ReplyToEmailAddress |
Gets or sets the reply to address for the notification email. |
string |
Data type: EmailAddress Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]+ Max length: 256 |
| EmailSubject |
Gets or sets the subject of the notification email. |
string |
Max length: 256 |
| EmailTemplate |
Gets or sets the email template that will be used for the body of the notification email. |
string |
None. |
| EmailRecipientDescription |
Gets or sets the list of email recipient types for this event. |
string |
None. |
| PushNotification |
Gets or sets a value indicating whether the client wants to receive push notifications. |
boolean |
Required |
| PushNotificationUrl |
Gets or sets the URL endpoint to send the push notification for the event. |
string |
Data type: Url Max length: 512 |
| UpdatedBy |
Gets or sets the name of the user that updated the model. |
string |
None. |
| UpdatedDate |
Gets or sets the date an time that the model was updated. |
date |
None. |
Response Formats
application/json, text/json
[
{
"ClientEventSubscriptionId": 1,
"ClientId": 1,
"EventTypeId": 1,
"EventType": "sample string 1",
"EmailNotification": true,
"FromEmailAddress": "sample string 3",
"FromEmailName": "sample string 4",
"ReplyToEmailAddress": "sample string 5",
"EmailSubject": "sample string 6",
"EmailTemplate": "sample string 7",
"EmailRecipientDescription": "sample string 8",
"PushNotification": true,
"PushNotificationUrl": "sample string 10",
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-07-26T20:29:23.0962535-07:00"
},
{
"ClientEventSubscriptionId": 1,
"ClientId": 1,
"EventTypeId": 1,
"EventType": "sample string 1",
"EmailNotification": true,
"FromEmailAddress": "sample string 3",
"FromEmailName": "sample string 4",
"ReplyToEmailAddress": "sample string 5",
"EmailSubject": "sample string 6",
"EmailTemplate": "sample string 7",
"EmailRecipientDescription": "sample string 8",
"PushNotification": true,
"PushNotificationUrl": "sample string 10",
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-07-26T20:29:23.0962535-07:00"
}
]
application/xml, text/xml
<ArrayOfEventSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.EventNotification">
<EventSubscriptionModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 11</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-07-26T20:29:23.0962535-07:00</UpdatedDate>
<ClientEventSubscriptionId>1</ClientEventSubscriptionId>
<ClientId>1</ClientId>
<EmailNotification>true</EmailNotification>
<EmailRecipientDescription>sample string 8</EmailRecipientDescription>
<EmailSubject>sample string 6</EmailSubject>
<EmailTemplate>sample string 7</EmailTemplate>
<EventType>sample string 1</EventType>
<EventTypeId>1</EventTypeId>
<FromEmailAddress>sample string 3</FromEmailAddress>
<FromEmailName>sample string 4</FromEmailName>
<PushNotification>true</PushNotification>
<PushNotificationUrl>sample string 10</PushNotificationUrl>
<ReplyToEmailAddress>sample string 5</ReplyToEmailAddress>
</EventSubscriptionModel>
<EventSubscriptionModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 11</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-07-26T20:29:23.0962535-07:00</UpdatedDate>
<ClientEventSubscriptionId>1</ClientEventSubscriptionId>
<ClientId>1</ClientId>
<EmailNotification>true</EmailNotification>
<EmailRecipientDescription>sample string 8</EmailRecipientDescription>
<EmailSubject>sample string 6</EmailSubject>
<EmailTemplate>sample string 7</EmailTemplate>
<EventType>sample string 1</EventType>
<EventTypeId>1</EventTypeId>
<FromEmailAddress>sample string 3</FromEmailAddress>
<FromEmailName>sample string 4</FromEmailName>
<PushNotification>true</PushNotification>
<PushNotificationUrl>sample string 10</PushNotificationUrl>
<ReplyToEmailAddress>sample string 5</ReplyToEmailAddress>
</EventSubscriptionModel>
</ArrayOfEventSubscriptionModel>