Candidates
To use EverReal playground is required to provide the Bearer token, read more on the Master Data page
To understand what is necessary and how to use GraphQK, on master data page we explain what is necessary to do
type Query {
candidates(input: CandidatesFilterListPaging): [Candidate]
}
type ListingCandidateApplication {
id: String
candidateId: String
email: String
userId: String
isMainCandidate: Boolean
applicationDataString: String
}
type Candidate {
id: String
email: String
firstName: String
lastName: String
fullName: String
rating: Float
candidateSource: String
isApplicant: Boolean
isDisabled: Boolean
isPendingCandidate: Boolean
isFromInvestment: Boolean
hasSharedDataRoom: Boolean
hadAcceptedSellingCancelationNotice: Boolean
viewingStartDate: DateTime
companyContactId: String
disabledReason: CandidateDisabledReason
statuses: CandidateStatuses
notificationStatuses: CandidateNotificationStatuses
applications: [ListingCandidateApplication]
listing: Listing
createdAt: DateTime
updatedAt: DateTime
}
type CandidateDisabledReason {
reason: String
message: String
}
type CandidateStatuses {
scheduledStatus: String
vettingStatus: String
disabledStatus: String
}
type CandidateNotificationStatuses {
hasReceivedStep2InviteEmail: DateTime
hasReceivedStep2InvitationFromAdmin: DateTime
hasReceivedGdprNotification: DateTime
hasReceived24hrsBeforeViewingReminder: DateTime
hasReceivedAfterViewingInviteReminder: DateTime
hasReceived24hrAfterViewingStep2Reminder: DateTime
hadReceivedSellingCancelationNotice: DateTime
}
input CandidatesFilter {
companyId: String
ownerId: String
propertyGroupId: String
propertyId: String
candidateSources: [String]
disabledReasons: [String]
isApplicant: Boolean
isDisabled: Boolean
from: Date
to: Date
external: Boolean
updatedAt: IDateRange
}
input CandidatesFilterListPaging {
filter: CandidatesFilter
paging: GraphPaging
sort: GraphSorting
}
GraphQL
cURL
Javascript
query candidates(
$companyId: String
$propertyId: String
$isApplicant: Boolean
) {
candidates(
input: {
paging: { take: 100, skip: 0 }
filter: {
companyId: $companyId
propertyId: $propertyId
isApplicant: $isApplicant
}
}
) {
id
email
firstName
lastName
fullName
rating
candidateSource
isApplicant
isDisabled
isPendingCandidate
isFromInvestment
hasSharedDataRoom
hadAcceptedSellingCancelationNotice
viewingStartDate
disabledReason {
reason
message
}
statuses {
scheduledStatus
vettingStatus
disabledStatus
}
notificationStatuses {
hasReceivedStep2InviteEmail
hasReceivedStep2InvitationFromAdmin
hasReceivedGdprNotification
hasReceived24hrsBeforeViewingReminder
hasReceivedAfterViewingInviteReminder
hasReceived24hrAfterViewingStep2Reminder
hadReceivedSellingCancelationNotice
}
applications {
id
candidateId
email
userId
isMainCandidate
applicationDataString
}
}
}
curl --location --request POST 'https://acme.everreal.co/api/reporting/graphql' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1Y2MyYjViYy05ODgxLTQyNTEtODcxNy0wZTg5NDlmNThjZTkiLCJzdWIiOiI0MTQ2OWVjMS0yMjkzLTRjMjMtYWVmNy1lZjA4YzBkZTU0ZjEiLCJleHAiOjE2NTY1MDYxMjIsImlhdCI6MTY1NjUwMjUyMn0.V8kvTMvixCnf3447KEW34dSKzGi11_wzLZv8nvEPEnwV1Ahnxjwk6bDHEUs1lvl7Rx1or6jky-TwlnM06Ztnlh_bDUXS0YwnpxKWI2kxX9okYDIaggXYaEGK_j0M-1-VALX8HOifT2GftrjY_VN4_iNYyHRYqrtLTKteJASf48vqCu-01C_6j4LdD6ZW-pxUVsLMZz8efWBQCWODhDaXKd443YM8Hws5MRSEOGrv3JxH9-sV1DNZFMCKxuHyqt_RaYDA-jR4xZVzALdEQfTVllJIDsJiM9-OvXGXTceqTr5tSlu2JNITHsGh_MX4253Wds-Z8G1oHrLvfI-SBiLOsg' \
--header 'Content-Type: application/json' \
--header 'Cookie: accept-language=en-US' \
--data-raw '{"query":"query candidates(\n $companyId: String\n $propertyId: String\n $isApplicant: Boolean\n) {\n candidates(\n input: {\n paging: { take: 100, skip: 0 }\n filter: {\n companyId: $companyId\n propertyId: $propertyId\n isApplicant: $isApplicant\n }\n }\n ) {\n id\n email\n firstName\n lastName\n fullName\n rating\n candidateSource\n isApplicant\n isDisabled\n isPendingCandidate\n isFromInvestment\n hasSharedDataRoom\n hadAcceptedSellingCancelationNotice\n viewingStartDate\n disabledReason {\n reason\n message\n }\n statuses {\n scheduledStatus\n vettingStatus\n disabledStatus\n }\n notificationStatuses {\n hasReceivedStep2InviteEmail\n hasReceivedStep2InvitationFromAdmin\n hasReceivedGdprNotification\n hasReceived24hrsBeforeViewingReminder\n hasReceivedAfterViewingInviteReminder\n hasReceived24hrAfterViewingStep2Reminder\n hadReceivedSellingCancelationNotice\n }\n applications {\n id\n candidateId\n email\n userId\n isMainCandidate\n applicationDataString\n }\n }\n}\n","variables":{}}'
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1Y2MyYjViYy05ODgxLTQyNTEtODcxNy0wZTg5NDlmNThjZTkiLCJzdWIiOiI0MTQ2OWVjMS0yMjkzLTRjMjMtYWVmNy1lZjA4YzBkZTU0ZjEiLCJleHAiOjE2NTY1MDYxMjIsImlhdCI6MTY1NjUwMjUyMn0.V8kvTMvixCnf3447KEW34dSKzGi11_wzLZv8nvEPEnwV1Ahnxjwk6bDHEUs1lvl7Rx1or6jky-TwlnM06Ztnlh_bDUXS0YwnpxKWI2kxX9okYDIaggXYaEGK_j0M-1-VALX8HOifT2GftrjY_VN4_iNYyHRYqrtLTKteJASf48vqCu-01C_6j4LdD6ZW-pxUVsLMZz8efWBQCWODhDaXKd443YM8Hws5MRSEOGrv3JxH9-sV1DNZFMCKxuHyqt_RaYDA-jR4xZVzALdEQfTVllJIDsJiM9-OvXGXTceqTr5tSlu2JNITHsGh_MX4253Wds-Z8G1oHrLvfI-SBiLOsg");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Cookie", "accept-language=en-US");
var graphql = JSON.stringify({
query: "query candidates(\n $companyId: String\n $propertyId: String\n $isApplicant: Boolean\n) {\n candidates(\n input: {\n paging: { take: 100, skip: 0 }\n filter: {\n companyId: $companyId\n propertyId: $propertyId\n isApplicant: $isApplicant\n }\n }\n ) {\n id\n email\n firstName\n lastName\n fullName\n rating\n candidateSource\n isApplicant\n isDisabled\n isPendingCandidate\n isFromInvestment\n hasSharedDataRoom\n hadAcceptedSellingCancelationNotice\n viewingStartDate\n disabledReason {\n reason\n message\n }\n statuses {\n scheduledStatus\n vettingStatus\n disabledStatus\n }\n notificationStatuses {\n hasReceivedStep2InviteEmail\n hasReceivedStep2InvitationFromAdmin\n hasReceivedGdprNotification\n hasReceived24hrsBeforeViewingReminder\n hasReceivedAfterViewingInviteReminder\n hasReceived24hrAfterViewingStep2Reminder\n hadReceivedSellingCancelationNotice\n }\n applications {\n id\n candidateId\n email\n userId\n isMainCandidate\n applicationDataString\n }\n }\n}\n",
variables: {}
})
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: graphql,
redirect: 'follow'
};
fetch("https://acme.everreal.co/api/reporting/graphql", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
Last modified 10d ago
Copy link