GET api/SigningRoomManager/SigningRooms/{signingRoomId}/Participants
Allows an organization admin, a client admin and a SigningRoom admin to get the list of participants associated to the specified SigningRoom.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| signingRoomId |
The SigningRoom identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The list of participants associated to the SigningRoom.
Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.ParticipantModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ParticipantId |
Gets or sets the participant identifier. |
integer |
None. |
| SigningRoomId |
Gets or sets the participant's SigningRoom identifier. |
integer |
None. |
| SortOrder |
Gets or sets the sort order for the participant. |
integer |
None. |
| ParticipantRoleTypeId |
Gets or sets the participant role type identifier. |
integer |
None. |
| FirstName |
Gets or sets the participant's first name. |
string |
Required Max length: 50 |
| LastName |
Gets or sets the participant's last name. |
string |
Required Max length: 50 |
| FullName |
Gets or sets the participant's full name. |
string |
None. |
| Initials |
Gets or sets the participant's initials. |
string |
None. |
| InvitationEmail |
Gets or sets the participant's email address. |
string |
Required Data type: EmailAddress Matching regular expression pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]+ Max length: 256 |
| InvitationCode |
Gets the participant's invitation code. |
string |
None. |
| AccessCode |
Gets or sets an optional access code that, if specified, the participant must provide when signing in to the SigningRoom for the first time. |
string |
Max length: 32 |
| SigningRoomUrl |
Gets or sets the participant's SigningRoom URL. |
string |
None. |
| ESignConsentAccepted |
Gets a value indicating whether the participant has accepted the esign consent. |
boolean |
None. |
| Deleted |
Gets or sets a value indicating whether the participant is deleted. |
boolean |
None. |
| 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
[
{
"ParticipantId": 1,
"SigningRoomId": 1,
"SortOrder": 1,
"ParticipantRoleTypeId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"FullName": "sample string 3",
"Initials": "sample string 4",
"InvitationEmail": "sample string 5",
"InvitationCode": "sample string 6",
"AccessCode": "sample string 7",
"SigningRoomUrl": "sample string 8",
"ESignConsentAccepted": true,
"Deleted": true,
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-01-01T17:32:47.6265194-05:00"
},
{
"ParticipantId": 1,
"SigningRoomId": 1,
"SortOrder": 1,
"ParticipantRoleTypeId": 1,
"FirstName": "sample string 1",
"LastName": "sample string 2",
"FullName": "sample string 3",
"Initials": "sample string 4",
"InvitationEmail": "sample string 5",
"InvitationCode": "sample string 6",
"AccessCode": "sample string 7",
"SigningRoomUrl": "sample string 8",
"ESignConsentAccepted": true,
"Deleted": true,
"UpdatedBy": "sample string 11",
"UpdatedDate": "2026-01-01T17:32:47.6265194-05:00"
}
]
application/xml, text/xml
<ArrayOfParticipantModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
<ParticipantModel>
<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-01-01T17:32:47.6265194-05:00</UpdatedDate>
<AccessCode>sample string 7</AccessCode>
<Deleted>true</Deleted>
<ESignConsentAccepted>true</ESignConsentAccepted>
<FirstName>sample string 1</FirstName>
<FullName>sample string 3</FullName>
<Initials>sample string 4</Initials>
<InvitationCode>sample string 6</InvitationCode>
<InvitationEmail>sample string 5</InvitationEmail>
<LastName>sample string 2</LastName>
<ParticipantId>1</ParticipantId>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomUrl>sample string 8</SigningRoomUrl>
<SortOrder>1</SortOrder>
</ParticipantModel>
<ParticipantModel>
<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-01-01T17:32:47.6265194-05:00</UpdatedDate>
<AccessCode>sample string 7</AccessCode>
<Deleted>true</Deleted>
<ESignConsentAccepted>true</ESignConsentAccepted>
<FirstName>sample string 1</FirstName>
<FullName>sample string 3</FullName>
<Initials>sample string 4</Initials>
<InvitationCode>sample string 6</InvitationCode>
<InvitationEmail>sample string 5</InvitationEmail>
<LastName>sample string 2</LastName>
<ParticipantId>1</ParticipantId>
<ParticipantRoleTypeId>1</ParticipantRoleTypeId>
<SigningRoomId>1</SigningRoomId>
<SigningRoomUrl>sample string 8</SigningRoomUrl>
<SortOrder>1</SortOrder>
</ParticipantModel>
</ArrayOfParticipantModel>