GET api/Candidate/{id}/CorrespondenceTemplate/{correspondenceTemplateTemplateId}/Mail
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
|
| correspondenceTemplateTemplateId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
ClientMail| Name | Description | Type | Additional information |
|---|---|---|---|
| CorrespondenceTemplateId | integer |
None. |
|
| CorrespondenceTemplateTemplateId | string |
None. |
|
| CorrespondenceTemplateParentTemplateId | string |
None. |
|
| CorrespondenceTemplateScopeId | integer |
None. |
|
| CorrespondenceTemplateName | string |
None. |
|
| ElementName | string |
None. |
|
| ElementId | integer |
None. |
|
| IsOptional | boolean |
None. |
|
| IsBulk | boolean |
None. |
|
| FileExtensions | string |
None. |
|
| SendAt | date |
None. |
|
| Id | integer |
None. |
|
| ScopeId | integer |
None. |
|
| UserId | integer |
None. |
|
| Privacy | string |
None. |
|
| Name | string |
None. |
|
| Type | string |
None. |
|
| ReceiverRole | string |
None. |
|
| AutoCreated | boolean |
None. |
|
| From | string |
None. |
|
| Sender | string |
None. |
|
| ReplyToList | string |
None. |
|
| To | string |
None. |
|
| CC | string |
None. |
|
| Bcc | string |
None. |
|
| Subject | string |
None. |
|
| Body | string |
None. |
|
| IsBodyHtml | boolean |
None. |
|
| Priority | string |
None. |
|
| DeliveryNotificationOptions | string |
None. |
|
| Origin | string |
None. |
|
| Status | string |
None. |
|
| ReferenceId | string |
None. |
|
| IsActive | boolean |
None. |
|
| Sort | integer |
None. |
|
| Comment | string |
None. |
|
| DatePublish | date |
None. |
|
| DateExpires | date |
None. |
|
| Version | date |
None. |
|
| IsDeleted | boolean |
None. |
|
| History | string |
None. |
|
| IdxMailElement | Collection of IdxMailElement |
None. |
|
| Scope | Scope |
None. |
|
| User | User |
None. |
|
| RowNumber | integer |
None. |
|
| Files | Object |
None. |
|
| ActivityLogs | Collection of ActivityLog |
None. |
|
| PendingTasks | Collection of PendingTask |
None. |
|
| SenderPortrait | Attachment |
None. |
|
| _Messages | Collection of ControllerMessage |
None. |
|
| ReplyToMatchingPercent | integer |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
text/csv
Sample:
"sep=," Id,ScopeId,OrganisationId,CandidateId,ApplicationId,Name,IsTrialday,StartDate,EndDate,Type,Category,Position,Sallery,JobDescription,Rating,Testimonial,Status,ReferenceId,IsActive,Sort,Comment,DatePublish,DateExpires,Version,IsDeleted,History,Organisation,Scope,Candidate,Application,RowNumber,OrganisationName,Documents,TypeString,CategoryString,PositionString,StatusString,_Messages,Files,Description,JoborderCategories,Content,Style,Joborders,JoborderTemplates,Language,KeyColumn,DisplayColumn,TypeColumn,ExtendedScopeTable,ElementName,ElementNamePlural,WelcomeMessage,Properties,PropertyGroups,PropertySections,AddressDefinitions,Filters,DefaultOrder,AssociationFilterTables,AssociationPropertyNames,MergeColumns,TimeStamp,GroupOrder,PreferredKind,PreferredTypes,PreferredCategories,PreferredPositions,PreferredEmloyerSelectionMode,PreferredOrganisationIds,PreferredRegions,PreferredSallery,PreferredStartDate,PreferredDurance,PreferredText,CurrentStatus,CurrentJobHuntingSince,CurrentEmployer,CurrentKind,CurrentType,CurrentCategory,CurrentPosition,CurrentSallery,CurrentChangeReason,CurrentNoticePeriod,CurrentEndOfEducation,CurrentEarliestEntryDate,CurrentExpectations,CoverLetter,VideoUrl,Consent,ConsentGDPR,CoverLetterFile,CandidateName,_ActivityLogs,Length,CorrespondenceTemplateId,CorrespondenceTemplateTemplateId,CorrespondenceTemplateParentTemplateId,CorrespondenceTemplateScopeId,CorrespondenceTemplateName,ElementId,IsOptional,IsBulk,FileExtensions,SendAt,UserId,Privacy,ReceiverRole,AutoCreated,From,Sender,ReplyToList,To,CC,Bcc,Subject,Body,IsBodyHtml,Priority,DeliveryNotificationOptions,Origin,IdxMailElement,User,ActivityLogs,PendingTasks,SenderPortrait,ReplyToMatchingPercent 1,2,3,4,5,sample string 6,True,2026-01-18 19:06:29,2026-01-18 19:06:29,sample string 8,sample string 9,sample string 10,sample string 11,sample string 12,1,sample string 13,sample string 14,sample string 15,True,17,sample string 18,18.01.2026 19:06:29 +01:00,18.01.2026 19:06:29 +01:00,18.01.2026 19:06:29 +01:00,True,sample string 23,ASTLib.Models.Organisation,ASTLib.Models.Scope,ASTLib.Models.Candidate,ASTLib.Models.Application,24,sample string 4,System.Object,sample string 26,sample string 27,sample string 28,sample string 29,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, 2,3,,,,sample string 4,,,,,,,,,,,,sample string 9,True,11,sample string 12,18.01.2026 19:33:28 +01:00,18.01.2026 19:33:28 +01:00,18.01.2026 19:33:28 +01:00,True,sample string 17,,ASTLib.Models.Scope,,,1,,,,,,,,System.Object[],sample string 5,sample string 6,sample string 7,sample string 8,System.Collections.Generic.List`1[ASTLib.Models.Joborder],System.Collections.Generic.List`1[ASTLib.Models.JoborderTemplate],,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, ,2,,,,sample string 1,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,sample string 3,sample string 4,sample string 5,sample string 6,,sample string 7,sample string 8,sample string 9,System.Collections.Generic.List`1[ASTLib.Types.Common.Property],System.Collections.Generic.List`1[ASTLib.Types.Common.PropertyGroup],System.Collections.Generic.List`1[ASTLib.Types.Common.PropertySection],System.Collections.Hashtable,"System.Collections.Generic.Dictionary`2[System.String,ASTLib.Types.Attributes.FilterColumnAttribute]","System.Collections.Generic.Dictionary`2[System.String,System.String]",System.Collections.Generic.List`1[System.String],System.Collections.Generic.List`1[System.String],System.Collections.Generic.List`1[System.String],2026-01-18 19:36:27,"System.Collections.Generic.Dictionary`2[System.String,System.Int32]",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, ,2,,,,sample string 1,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,sample string 3,sample string 4,sample string 5,sample string 6,,sample string 7,sample string 8,sample string 9,System.Collections.Generic.List`1[ASTLib.Types.Common.Property],System.Collections.Generic.List`1[ASTLib.Types.Common.PropertyGroup],System.Collections.Generic.List`1[ASTLib.Types.Common.PropertySection],System.Collections.Hashtable,"System.Collections.Generic.Dictionary`2[System.String,ASTLib.Types.Attributes.FilterColumnAttribute]","System.Collections.Generic.Dictionary`2[System.String,System.String]",System.Collections.Generic.List`1[System.String],System.Collections.Generic.List`1[System.String],System.Collections.Generic.List`1[System.String],2026-01-18 19:43:58,"System.Collections.Generic.Dictionary`2[System.String,System.Int32]",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, 1,2,,1,,sample string 3,,,,,,,,,,,sample string 27,sample string 28,True,30,sample string 31,18.01.2026 19:48:16 +01:00,18.01.2026 19:48:16 +01:00,18.01.2026 19:48:16 +01:00,True,sample string 36,,ASTLib.Models.Scope,,,37,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,sample string 4,sample string 5,sample string 6,sample string 7,1,sample string 8,sample string 9,sample string 10,sample string 11,sample string 12,sample string 13,sample string 14,2026-01-18 19:48:16,sample string 15,sample string 16,sample string 17,sample string 18,sample string 19,sample string 20,sample string 21,sample string 22,2026-01-18 19:48:16,2026-01-18 19:48:16,sample string 23,sample string 24,sample string 25,True,True,System.Object,,System.Collections.Generic.List`1[ASTLib.Models.ActivityLog],,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, ,2,,,,sample string 1,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,sample string 3,sample string 4,sample string 5,sample string 6,,sample string 7,sample string 8,sample string 9,System.Collections.Generic.List`1[ASTLib.Types.Common.Property],System.Collections.Generic.List`1[ASTLib.Types.Common.PropertyGroup],System.Collections.Generic.List`1[ASTLib.Types.Common.PropertySection],System.Collections.Hashtable,"System.Collections.Generic.Dictionary`2[System.String,ASTLib.Types.Attributes.FilterColumnAttribute]","System.Collections.Generic.Dictionary`2[System.String,System.String]",System.Collections.Generic.List`1[System.String],System.Collections.Generic.List`1[System.String],System.Collections.Generic.List`1[System.String],2026-01-18 19:53:01,"System.Collections.Generic.Dictionary`2[System.String,System.Int32]",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,15,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, 11,12,,,,sample string 14,,,,sample string 15,,,,,,,sample string 30,sample string 31,True,33,sample string 34,18.01.2026 20:38:35 +01:00,18.01.2026 20:38:35 +01:00,18.01.2026 20:38:35 +01:00,True,sample string 39,,ASTLib.Models.Scope,,,40,,,,,,,,System.Object,,,,,,,,,,,,sample string 6,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,sample string 2,sample string 3,4,sample string 5,7,True,True,sample string 10,18.01.2026 20:38:35 +01:00,1,sample string 13,sample string 16,True,sample string 18,sample string 19,sample string 20,sample string 21,sample string 22,sample string 23,sample string 24,sample string 25,True,sample string 27,sample string 28,sample string 29,System.Collections.Generic.List`1[ASTLib.Models.IdxMailElement],ASTLib.Models.User,System.Collections.Generic.List`1[ASTLib.Models.ActivityLog],System.Collections.Generic.List`1[ASTLib.Models.PendingTask],ASTLib.Models.Attachment,42