POST api/Candidate/GetCandidates
Request Information
URI Parameters
None.
Body Parameters
CandidateInboxSearchCriteriaDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| CandidateIds | Collection of integer |
None. |
|
| CandidateName | string |
None. |
|
| Zip | string |
None. |
|
| City | string |
None. |
|
| AssociateId | integer |
None. |
|
| CallStatus | CandidateCallStatusTypeEnum |
None. |
|
| Proximity | ProximityEnum |
None. |
|
| SortByFilter | CandidateSortByFilterEnum |
None. |
|
| SourceLatitude | decimal number |
None. |
|
| SourceLongitude | decimal number |
None. |
|
| PageIndex | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortBy | string |
None. |
|
| SortOrder | string |
None. |
|
| SortColumnIndex | integer |
None. |
|
| PhoneNo | string |
None. |
|
| LocationContextCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CandidateIds": [
1,
2
],
"CandidateName": "sample string 1",
"Zip": "sample string 2",
"City": "sample string 3",
"AssociateId": 1,
"CallStatus": 1,
"Proximity": 1,
"SortByFilter": 1,
"SourceLatitude": 1.1,
"SourceLongitude": 1.1,
"PageIndex": 1,
"PageSize": 1,
"SortBy": "sample string 4",
"SortOrder": "sample string 5",
"SortColumnIndex": 1,
"PhoneNo": "sample string 6",
"LocationContextCode": "sample string 7"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PagedDTOOfCandidateDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PagedRecords | Collection of CandidateDTO |
None. |
|
| Data | Collection of CandidateDTO |
None. |
|
| TotalRecords | integer |
None. |
|
| TotalAssociateRecords | integer |
None. |
|
| CwaTotal | decimal number |
None. |
|
| AlpTotal | decimal number |
None. |
|
| AnHTotal | decimal number |
None. |
|
| SubmittedAgentCount | integer |
None. |
|
| TotalNoPrds | integer |
None. |
|
| TotalCompletedNoPrds | decimal number |
None. |
|
| TotalCancelNoPrds | integer |
None. |
|
| TotalAlpNoPrds | decimal number |
None. |
|
| FormattedTotalAlpNoPrds | string |
None. |
|
| TotalCompletedAlpNoPrds | decimal number |
None. |
|
| FormattedTotalCompletedAlpNoPrds | string |
None. |
|
| TotalCancelAlpNoPrds | decimal number |
None. |
|
| FormattedTotalCancelAlpNoPrds | string |
None. |
|
| IsSearchLimitCompleted | boolean |
None. |
|
| PolicySearchesLeft | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"PagedRecords": [
{
"isBulk": true,
"BulkCandidateIds": [
1,
2
],
"CandidateId": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"MiddleInitial": "sample string 5",
"AssociateId": 1,
"PersonallyRecrutedAsssId": 1,
"AssociateContractId": 1,
"DateOfBirth": "2025-10-14T00:40:24.403437-07:00",
"AssignmentDate": "2025-10-14T00:40:24.403437-07:00",
"Address": "sample string 6",
"Address2": "sample string 7",
"GeoAddress": "sample string 8",
"Zip": "sample string 9",
"Email": "sample string 10",
"WorkEmail": "sample string 11",
"HomePhone": "sample string 12",
"FormattedHomePhone": "12",
"MobilePhone": "sample string 13",
"FormattedMobilePhone": "13",
"WorkPhone": "sample string 14",
"FormattedWorkPhone": "14",
"StrikeIronPhoneNumber": "sample string 15",
"FormattedStrikeIronPhoneNumber": "sample string 15",
"MobilePhoneOrHomePhone": "sample string 13",
"FomattedMobilePhoneOrHomePhone": "13",
"StateId": 1,
"CityId": 1,
"State": "sample string 16",
"StateCode": "sample string 17",
"City": "sample string 18",
"CountryId": 1,
"Country": "sample string 19",
"IsCalled": true,
"HasAppointmentInThePast": true,
"HasAppointment": true,
"HasComment": true,
"CandidateSourceId": 24,
"CandidateSource": "sample string 25",
"CandidateCallStatusId": 1,
"CandidateCallStatus": "sample string 26",
"CandidateIndex": 27,
"CandidateStatusId": 28,
"CandidateStatus": "sample string 29",
"IsPositiveMarked": true,
"IsPrinted": true,
"SavedForAssociateId": 1,
"SavedByResumeAssistant": true,
"ResumeType": "sample string 32",
"CreateDate": "2025-10-14T00:40:24.403437-07:00",
"UpcomingAppointmentDateString": "sample string 34",
"PassedAppointmentDateString": "sample string 35",
"CandidateUserId": 1,
"CreateDateShortDateString": "10/14/2025",
"LatestAppointmentShortDateString": "sample string 36",
"LatestAppointment": "2025-10-14T00:40:24.403437-07:00",
"FullName": "sample string 4, sample string 3",
"DateofBirthShortDateString": "10/14/2025",
"AssignDateShortDateString": "10/14/2025",
"ComposedAddress": "sample string 6 , sample string 18, sample string 16 sample string 9",
"PrimaryCandidateAddressLatitude": 37.1,
"PrimaryCandidateAddressLongitude": 38.1,
"IsGeoCodeAttempted": true,
"HasCandidateGeoCoded": true,
"GeoCodeStatus": 1,
"LocationCode": "sample string 39",
"CityDisplay": "sample string 18, sample string 17",
"LatestComment": {
"LeadId": 1,
"CandidateId": 1,
"CommentId": 1,
"Comment": "sample string 2",
"CommentDate": "2025-10-14T00:40:24.403437-07:00",
"ManagerAssociateId": 1,
"AgentName": "sample string 3"
},
"RecentActivities": [
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
},
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
}
],
"FileName": "sample string 40",
"S3FileName": "sample string 41",
"ContentType": "sample string 42",
"UploadedByWeb": true,
"FileBytes": "QEA=",
"AssigmentGuid": "27b447a7-9b67-4f6b-b69b-81577e9e52d7",
"AssignedStatus": "sample string 44",
"lastEventId": 1,
"IsAssigned": false,
"IsFirstInterview": false,
"IsSecondInterview": false,
"IsThirdInterview": false,
"IsFourthInterview": false,
"IsFifthInterview": false,
"ResponseDate": "sample string 45",
"isDualContext": true
},
{
"isBulk": true,
"BulkCandidateIds": [
1,
2
],
"CandidateId": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"MiddleInitial": "sample string 5",
"AssociateId": 1,
"PersonallyRecrutedAsssId": 1,
"AssociateContractId": 1,
"DateOfBirth": "2025-10-14T00:40:24.403437-07:00",
"AssignmentDate": "2025-10-14T00:40:24.403437-07:00",
"Address": "sample string 6",
"Address2": "sample string 7",
"GeoAddress": "sample string 8",
"Zip": "sample string 9",
"Email": "sample string 10",
"WorkEmail": "sample string 11",
"HomePhone": "sample string 12",
"FormattedHomePhone": "12",
"MobilePhone": "sample string 13",
"FormattedMobilePhone": "13",
"WorkPhone": "sample string 14",
"FormattedWorkPhone": "14",
"StrikeIronPhoneNumber": "sample string 15",
"FormattedStrikeIronPhoneNumber": "sample string 15",
"MobilePhoneOrHomePhone": "sample string 13",
"FomattedMobilePhoneOrHomePhone": "13",
"StateId": 1,
"CityId": 1,
"State": "sample string 16",
"StateCode": "sample string 17",
"City": "sample string 18",
"CountryId": 1,
"Country": "sample string 19",
"IsCalled": true,
"HasAppointmentInThePast": true,
"HasAppointment": true,
"HasComment": true,
"CandidateSourceId": 24,
"CandidateSource": "sample string 25",
"CandidateCallStatusId": 1,
"CandidateCallStatus": "sample string 26",
"CandidateIndex": 27,
"CandidateStatusId": 28,
"CandidateStatus": "sample string 29",
"IsPositiveMarked": true,
"IsPrinted": true,
"SavedForAssociateId": 1,
"SavedByResumeAssistant": true,
"ResumeType": "sample string 32",
"CreateDate": "2025-10-14T00:40:24.403437-07:00",
"UpcomingAppointmentDateString": "sample string 34",
"PassedAppointmentDateString": "sample string 35",
"CandidateUserId": 1,
"CreateDateShortDateString": "10/14/2025",
"LatestAppointmentShortDateString": "sample string 36",
"LatestAppointment": "2025-10-14T00:40:24.403437-07:00",
"FullName": "sample string 4, sample string 3",
"DateofBirthShortDateString": "10/14/2025",
"AssignDateShortDateString": "10/14/2025",
"ComposedAddress": "sample string 6 , sample string 18, sample string 16 sample string 9",
"PrimaryCandidateAddressLatitude": 37.1,
"PrimaryCandidateAddressLongitude": 38.1,
"IsGeoCodeAttempted": true,
"HasCandidateGeoCoded": true,
"GeoCodeStatus": 1,
"LocationCode": "sample string 39",
"CityDisplay": "sample string 18, sample string 17",
"LatestComment": {
"LeadId": 1,
"CandidateId": 1,
"CommentId": 1,
"Comment": "sample string 2",
"CommentDate": "2025-10-14T00:40:24.403437-07:00",
"ManagerAssociateId": 1,
"AgentName": "sample string 3"
},
"RecentActivities": [
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
},
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
}
],
"FileName": "sample string 40",
"S3FileName": "sample string 41",
"ContentType": "sample string 42",
"UploadedByWeb": true,
"FileBytes": "QEA=",
"AssigmentGuid": "27b447a7-9b67-4f6b-b69b-81577e9e52d7",
"AssignedStatus": "sample string 44",
"lastEventId": 1,
"IsAssigned": false,
"IsFirstInterview": false,
"IsSecondInterview": false,
"IsThirdInterview": false,
"IsFourthInterview": false,
"IsFifthInterview": false,
"ResponseDate": "sample string 45",
"isDualContext": true
}
],
"Data": [
{
"isBulk": true,
"BulkCandidateIds": [
1,
2
],
"CandidateId": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"MiddleInitial": "sample string 5",
"AssociateId": 1,
"PersonallyRecrutedAsssId": 1,
"AssociateContractId": 1,
"DateOfBirth": "2025-10-14T00:40:24.403437-07:00",
"AssignmentDate": "2025-10-14T00:40:24.403437-07:00",
"Address": "sample string 6",
"Address2": "sample string 7",
"GeoAddress": "sample string 8",
"Zip": "sample string 9",
"Email": "sample string 10",
"WorkEmail": "sample string 11",
"HomePhone": "sample string 12",
"FormattedHomePhone": "12",
"MobilePhone": "sample string 13",
"FormattedMobilePhone": "13",
"WorkPhone": "sample string 14",
"FormattedWorkPhone": "14",
"StrikeIronPhoneNumber": "sample string 15",
"FormattedStrikeIronPhoneNumber": "sample string 15",
"MobilePhoneOrHomePhone": "sample string 13",
"FomattedMobilePhoneOrHomePhone": "13",
"StateId": 1,
"CityId": 1,
"State": "sample string 16",
"StateCode": "sample string 17",
"City": "sample string 18",
"CountryId": 1,
"Country": "sample string 19",
"IsCalled": true,
"HasAppointmentInThePast": true,
"HasAppointment": true,
"HasComment": true,
"CandidateSourceId": 24,
"CandidateSource": "sample string 25",
"CandidateCallStatusId": 1,
"CandidateCallStatus": "sample string 26",
"CandidateIndex": 27,
"CandidateStatusId": 28,
"CandidateStatus": "sample string 29",
"IsPositiveMarked": true,
"IsPrinted": true,
"SavedForAssociateId": 1,
"SavedByResumeAssistant": true,
"ResumeType": "sample string 32",
"CreateDate": "2025-10-14T00:40:24.403437-07:00",
"UpcomingAppointmentDateString": "sample string 34",
"PassedAppointmentDateString": "sample string 35",
"CandidateUserId": 1,
"CreateDateShortDateString": "10/14/2025",
"LatestAppointmentShortDateString": "sample string 36",
"LatestAppointment": "2025-10-14T00:40:24.403437-07:00",
"FullName": "sample string 4, sample string 3",
"DateofBirthShortDateString": "10/14/2025",
"AssignDateShortDateString": "10/14/2025",
"ComposedAddress": "sample string 6 , sample string 18, sample string 16 sample string 9",
"PrimaryCandidateAddressLatitude": 37.1,
"PrimaryCandidateAddressLongitude": 38.1,
"IsGeoCodeAttempted": true,
"HasCandidateGeoCoded": true,
"GeoCodeStatus": 1,
"LocationCode": "sample string 39",
"CityDisplay": "sample string 18, sample string 17",
"LatestComment": {
"LeadId": 1,
"CandidateId": 1,
"CommentId": 1,
"Comment": "sample string 2",
"CommentDate": "2025-10-14T00:40:24.403437-07:00",
"ManagerAssociateId": 1,
"AgentName": "sample string 3"
},
"RecentActivities": [
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
},
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
}
],
"FileName": "sample string 40",
"S3FileName": "sample string 41",
"ContentType": "sample string 42",
"UploadedByWeb": true,
"FileBytes": "QEA=",
"AssigmentGuid": "27b447a7-9b67-4f6b-b69b-81577e9e52d7",
"AssignedStatus": "sample string 44",
"lastEventId": 1,
"IsAssigned": false,
"IsFirstInterview": false,
"IsSecondInterview": false,
"IsThirdInterview": false,
"IsFourthInterview": false,
"IsFifthInterview": false,
"ResponseDate": "sample string 45",
"isDualContext": true
},
{
"isBulk": true,
"BulkCandidateIds": [
1,
2
],
"CandidateId": 2,
"FirstName": "sample string 3",
"LastName": "sample string 4",
"MiddleInitial": "sample string 5",
"AssociateId": 1,
"PersonallyRecrutedAsssId": 1,
"AssociateContractId": 1,
"DateOfBirth": "2025-10-14T00:40:24.403437-07:00",
"AssignmentDate": "2025-10-14T00:40:24.403437-07:00",
"Address": "sample string 6",
"Address2": "sample string 7",
"GeoAddress": "sample string 8",
"Zip": "sample string 9",
"Email": "sample string 10",
"WorkEmail": "sample string 11",
"HomePhone": "sample string 12",
"FormattedHomePhone": "12",
"MobilePhone": "sample string 13",
"FormattedMobilePhone": "13",
"WorkPhone": "sample string 14",
"FormattedWorkPhone": "14",
"StrikeIronPhoneNumber": "sample string 15",
"FormattedStrikeIronPhoneNumber": "sample string 15",
"MobilePhoneOrHomePhone": "sample string 13",
"FomattedMobilePhoneOrHomePhone": "13",
"StateId": 1,
"CityId": 1,
"State": "sample string 16",
"StateCode": "sample string 17",
"City": "sample string 18",
"CountryId": 1,
"Country": "sample string 19",
"IsCalled": true,
"HasAppointmentInThePast": true,
"HasAppointment": true,
"HasComment": true,
"CandidateSourceId": 24,
"CandidateSource": "sample string 25",
"CandidateCallStatusId": 1,
"CandidateCallStatus": "sample string 26",
"CandidateIndex": 27,
"CandidateStatusId": 28,
"CandidateStatus": "sample string 29",
"IsPositiveMarked": true,
"IsPrinted": true,
"SavedForAssociateId": 1,
"SavedByResumeAssistant": true,
"ResumeType": "sample string 32",
"CreateDate": "2025-10-14T00:40:24.403437-07:00",
"UpcomingAppointmentDateString": "sample string 34",
"PassedAppointmentDateString": "sample string 35",
"CandidateUserId": 1,
"CreateDateShortDateString": "10/14/2025",
"LatestAppointmentShortDateString": "sample string 36",
"LatestAppointment": "2025-10-14T00:40:24.403437-07:00",
"FullName": "sample string 4, sample string 3",
"DateofBirthShortDateString": "10/14/2025",
"AssignDateShortDateString": "10/14/2025",
"ComposedAddress": "sample string 6 , sample string 18, sample string 16 sample string 9",
"PrimaryCandidateAddressLatitude": 37.1,
"PrimaryCandidateAddressLongitude": 38.1,
"IsGeoCodeAttempted": true,
"HasCandidateGeoCoded": true,
"GeoCodeStatus": 1,
"LocationCode": "sample string 39",
"CityDisplay": "sample string 18, sample string 17",
"LatestComment": {
"LeadId": 1,
"CandidateId": 1,
"CommentId": 1,
"Comment": "sample string 2",
"CommentDate": "2025-10-14T00:40:24.403437-07:00",
"ManagerAssociateId": 1,
"AgentName": "sample string 3"
},
"RecentActivities": [
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
},
{
"ActivityShortName": "sample string 1",
"ActivityName": "sample string 2",
"ActivityDate": "2025-10-14T00:40:24.403437-07:00",
"ActivityTime": "2025-10-14T00:40:24.403437-07:00",
"ActivityCategory": "sample string 3",
"ActivityById": 4,
"ActivityByName": "sample string 5",
"ActivityComment": "sample string 6",
"AppointmentType": 1,
"CallStatus": 1,
"PhoneNumber": "sample string 7",
"LeadId": 1,
"IsMira": true,
"ActivityDescription": "sample string 9",
"ActivityHeading": "sample string 10",
"AppointmentDate": "2025-10-14T00:40:24.403437-07:00",
"HasDateTimePreference": true
}
],
"FileName": "sample string 40",
"S3FileName": "sample string 41",
"ContentType": "sample string 42",
"UploadedByWeb": true,
"FileBytes": "QEA=",
"AssigmentGuid": "27b447a7-9b67-4f6b-b69b-81577e9e52d7",
"AssignedStatus": "sample string 44",
"lastEventId": 1,
"IsAssigned": false,
"IsFirstInterview": false,
"IsSecondInterview": false,
"IsThirdInterview": false,
"IsFourthInterview": false,
"IsFifthInterview": false,
"ResponseDate": "sample string 45",
"isDualContext": true
}
],
"TotalRecords": 1,
"TotalAssociateRecords": 2,
"CwaTotal": 3.1,
"AlpTotal": 4.1,
"AnHTotal": 5.1,
"SubmittedAgentCount": 6,
"TotalNoPrds": 7,
"TotalCompletedNoPrds": 8.1,
"TotalCancelNoPrds": 9,
"TotalAlpNoPrds": 10.1,
"FormattedTotalAlpNoPrds": "10.10",
"TotalCompletedAlpNoPrds": 11.1,
"FormattedTotalCompletedAlpNoPrds": "11.10",
"TotalCancelAlpNoPrds": 12.1,
"FormattedTotalCancelAlpNoPrds": "12.10",
"IsSearchLimitCompleted": true,
"PolicySearchesLeft": "sample string 14"
}