GET api/v1/forms/registrations/emails

List form registration email

Request Information

URI Parameters

Name	Description	Type	Additional information
Filter	Filter records	ListFormRegistrationEmailV1Filter	None.
Select	Select columns	Collection of ListFormRegistrationEmailV1Select	Default value: All Example value: FormRegistrationId, EmailRecipients Unique items
Sort	Sort records Sort by the first column, then by the second column, and so on	Collection of ListFormRegistrationEmailV1Sort	Default value: SerialNumber Example value: SerialNumber Max items: 3 Unique items
PageNumber	Page number	integer (32 bits)	Default value: 1 Example value: 1 Range: inclusive between 1 and 2147483647
PageSize	Number of records per page	integer (32 bits)	Default value: 10 Example value: 10 Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of form registration emails

ListFormRegistrationEmailV1Response

Name	Description	Type	Additional information
FormRegistrationEmails	List of form registration emails	Collection of ListFormRegistrationEmailV1ResponseEmail	None.
Total	Total number of records matching the request	integer (32 bits)	Required Example value: 42 Range: inclusive between 0 and 2147483647

Name

Description

Type

Additional information

FormRegistrationEmails

List of form registration emails

Collection of ListFormRegistrationEmailV1ResponseEmail

None.

Total

Total number of records matching the request

integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:

{
  "FormRegistrationEmails": [
    {
      "FormRegistrationEmailId": "4adaaf11-8b29-4b5d-861c-1f6d18b1672d",
      "FormRegistrationId": "eb6a590c-2112-49d4-82be-0c2e93411d8f",
      "EmailRecipients": [
        {
          "Email": "example@email"
        },
        {
          "Email": "example@email"
        }
      ],
      "Files": [
        {
          "FileId": "05e622d4-e8b2-4ae6-9250-d59da8c6b790"
        },
        {
          "FileId": "05e622d4-e8b2-4ae6-9250-d59da8c6b790"
        }
      ]
    },
    {
      "FormRegistrationEmailId": "4adaaf11-8b29-4b5d-861c-1f6d18b1672d",
      "FormRegistrationId": "eb6a590c-2112-49d4-82be-0c2e93411d8f",
      "EmailRecipients": [
        {
          "Email": "example@email"
        },
        {
          "Email": "example@email"
        }
      ],
      "Files": [
        {
          "FileId": "05e622d4-e8b2-4ae6-9250-d59da8c6b790"
        },
        {
          "FileId": "05e622d4-e8b2-4ae6-9250-d59da8c6b790"
        }
      ]
    }
  ],
  "Total": 42
}