Contacts API: People

Retrieves one specific pending person

get
Authorizations
BearerstringRequired
Path parameters
pendingstring · uuidRequired
Responses
get
/api/contacts/pending-people/{pending}
404

Not Found

put
Authorizations
BearerstringRequired
Path parameters
pendingstring · uuidRequired
Body
PendingIdstring · uuidOptional
PersonIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
Responses
chevron-right
200

OK

No content

put
/api/contacts/pending-people/{pending}

No content

delete
Authorizations
BearerstringRequired
Path parameters
pendingstring · uuidRequired
Responses
chevron-right
200

OK

No content

delete
/api/contacts/pending-people/{pending}

No content

Checks for the existence of one specific pending person

head
Authorizations
BearerstringRequired
Path parameters
pendingstring · uuidRequired
Responses
chevron-right
200

OK

No content

head
/api/contacts/pending-people/{pending}

No content

Collects the list of pending people that match specific criteria

post
Authorizations
BearerstringRequired
Body
SubmittedBystring · uuid · nullableOptional
PersonIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
SubmittedBeforestring · date-time · nullableOptional
SubmittedSincestring · date-time · nullableOptional
Responses
chevron-right
200

OK

SubmittedBystring · uuidOptional
PendingIdstring · uuidOptional
PersonIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
SubmittedAtstring · date-timeOptional
post
/api/contacts/pending-people/collect
200

OK

Counts the pending people that match specific criteria

post
Authorizations
BearerstringRequired
Body
SubmittedBystring · uuid · nullableOptional
PersonIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
SubmittedBeforestring · date-time · nullableOptional
SubmittedSincestring · date-time · nullableOptional
Responses
chevron-right
200

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post
/api/contacts/pending-people/count
200

OK

Downloads the list of pending people that match specific criteria

post
Authorizations
BearerstringRequired
Body
SubmittedBystring · uuid · nullableOptional
PersonIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
SubmittedBeforestring · date-time · nullableOptional
SubmittedSincestring · date-time · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/contacts/pending-people/download
200

OK

No content

Searches for the list of pending people that match specific criteria

post
Authorizations
BearerstringRequired
Body
SubmittedBystring · uuid · nullableOptional
PersonIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
SubmittedBeforestring · date-time · nullableOptional
SubmittedSincestring · date-time · nullableOptional
Responses
chevron-right
200

OK

PendingIdstring · uuidOptional
PendingStatusstring · nullableOptional
SubmittedAtstring · date-timeOptional
SubmittedWhenstring · nullableOptional
SubmittedBystring · uuidOptional
SubmittedByNamestring · nullableOptional
UserIdstring · uuid · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
PersonIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
post
/api/contacts/pending-people/search
200

OK

post
Authorizations
BearerstringRequired
Body
PendingIdstring · uuidOptional
PersonIdstring · uuid · nullableOptional
UserIdstring · uuid · nullableOptional
PersonCodestring · nullableOptional
UserEmailstring · nullableOptional
UserFirstNamestring · nullableOptional
UserLastNamestring · nullableOptional
Responses
post
/api/contacts/pending-people

Retrieves one specific person

get
Authorizations
BearerstringRequired
Path parameters
personstring · uuidRequired
Responses
get
/api/contacts/people/{person}
404

Not Found

Checks for the existence of one specific person

head
Authorizations
BearerstringRequired
Path parameters
personstring · uuidRequired
Responses
chevron-right
200

OK

No content

head
/api/contacts/people/{person}

No content

Collects the list of people that match specific criteria

post
Authorizations
BearerstringRequired
Body
UserIdstring · uuid · nullableOptional
EmailExactstring · nullableOptional
EventRolestring · nullableOptional
FullNamestring · nullableOptional
PersonCodestring · nullableOptional
LastAuthenticatedSincestring · date-time · nullableOptional
IsApprovedboolean · nullableOptional
Responses
chevron-right
200

OK

FullNamestring · nullableOptional
PersonFirstNamestring · nullableOptional
PersonMiddleNamestring · nullableOptional
PersonLastNamestring · nullableOptional
PersonTypestring · nullableOptional
PersonCodestring · nullableOptional
PersonIdstring · uuidOptional
UserIdstring · uuidOptional
UserNamestring · nullableOptional
UserEmailstring · nullableOptional
UserEmailAlternatestring · nullableOptional
IsAdministratorbooleanOptional
IsDeveloperbooleanOptional
IsLearnerbooleanOptional
IsOperatorbooleanOptional
AccessRevokedstring · date-time · nullableOptional
AccessRevokedBystring · nullableOptional
LastAuthenticatedstring · date-time · nullableOptional
UserAccessGrantedstring · date-time · nullableOptional
UserAccessGrantedBystring · nullableOptional
UserApproveReasonstring · nullableOptional
WelcomeEmailsSentToUserinteger · int32 · nullableOptional
EmailAlternateEnabledbooleanOptional
EmailEnabledbooleanOptional
MarketingEmailEnabledbooleanOptional
Phonestring · nullableOptional
PhoneFaxstring · nullableOptional
PhoneHomestring · nullableOptional
PhoneOtherstring · nullableOptional
PhoneWorkstring · nullableOptional
ShippingPreferencestring · nullableOptional
EmergencyContactNamestring · nullableOptional
EmergencyContactPhonestring · nullableOptional
EmergencyContactRelationshipstring · nullableOptional
AgeGroupstring · nullableOptional
Birthdatestring · date-time · nullableOptional
Citizenshipstring · nullableOptional
FirstLanguagestring · nullableOptional
Genderstring · nullableOptional
Languagestring · nullableOptional
Regionstring · nullableOptional
TimeZonestring · nullableOptional
EmployerGroupIdstring · uuid · nullableOptional
EmployeeTypestring · nullableOptional
EmployeeUnionstring · nullableOptional
JobDivisionstring · nullableOptional
JobTitlestring · nullableOptional
JobsApprovedstring · date-time · nullableOptional
JobsApprovedBystring · nullableOptional
OccupationStandardIdstring · uuid · nullableOptional
CandidateCompletionProfilePercentinteger · int32 · nullableOptional
CandidateCompletionResumePercentinteger · int32 · nullableOptional
CandidateIsActivelySeekingboolean · nullableOptional
CandidateIsWillingToRelocateboolean · nullableOptional
CandidateLinkedInUrlstring · nullableOptional
CandidateOccupationListstring · nullableOptional
ImmigrationApplicantstring · nullableOptional
ImmigrationCategorystring · nullableOptional
ImmigrationDestinationstring · nullableOptional
ImmigrationDisabilitystring · nullableOptional
ImmigrationLandingDatestring · date-time · nullableOptional
ImmigrationNumberstring · nullableOptional
MemberEndDatestring · date-time · nullableOptional
MembershipStatusItemIdstring · uuid · nullableOptional
MemberStartDatestring · date-time · nullableOptional
CredentialingCountrystring · nullableOptional
EducationLevelstring · nullableOptional
IndustryItemIdstring · uuid · nullableOptional
SocialInsuranceNumberstring · nullableOptional
TradeworkerNumberstring · nullableOptional
ConsentConsultationstring · nullableOptional
ConsentToSharestring · nullableOptional
Referrerstring · nullableOptional
ReferrerOtherstring · nullableOptional
IsArchivedbooleanOptional
WhenArchivedstring · date-time · nullableOptional
WhenUnarchivedstring · date-time · nullableOptional
AccountReviewCompletedstring · date-time · nullableOptional
AccountReviewQueuedstring · date-time · nullableOptional
WebSiteUrlstring · nullableOptional
Createdstring · date-timeOptional
CreatedBystring · uuid · nullableOptional
CustomKeyinteger · int32 · nullableOptional
Modifiedstring · date-timeOptional
ModifiedBystring · uuidOptional
SinModifiedstring · date-time · nullableOptional
post
/api/contacts/people/collect
200

OK

Counts the people that match specific criteria

post
Authorizations
BearerstringRequired
Body
UserIdstring · uuid · nullableOptional
EmailExactstring · nullableOptional
EventRolestring · nullableOptional
FullNamestring · nullableOptional
PersonCodestring · nullableOptional
LastAuthenticatedSincestring · date-time · nullableOptional
IsApprovedboolean · nullableOptional
Responses
chevron-right
200

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post
/api/contacts/people/count
200

OK

Downloads the list of people that match specific criteria

post
Authorizations
BearerstringRequired
Body
UserIdstring · uuid · nullableOptional
EmailExactstring · nullableOptional
EventRolestring · nullableOptional
FullNamestring · nullableOptional
PersonCodestring · nullableOptional
LastAuthenticatedSincestring · date-time · nullableOptional
IsApprovedboolean · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/contacts/people/download
200

OK

No content

Searches for the list of people that match specific criteria

post
Authorizations
BearerstringRequired
Body
UserIdstring · uuid · nullableOptional
EmailExactstring · nullableOptional
EventRolestring · nullableOptional
FullNamestring · nullableOptional
PersonCodestring · nullableOptional
LastAuthenticatedSincestring · date-time · nullableOptional
IsApprovedboolean · nullableOptional
Responses
chevron-right
200

OK

PersonIdstring · uuidOptional
PersonCodestring · nullableOptional
PersonFirstNamestring · nullableOptional
PersonMiddleNamestring · nullableOptional
PersonLastNamestring · nullableOptional
UserIdstring · uuidOptional
UserNamestring · nullableOptional
UserEmailstring · nullableOptional
IsAdministratorbooleanOptional
IsDeveloperbooleanOptional
IsLearnerbooleanOptional
IsOperatorbooleanOptional
TimeZonestring · nullableOptional
post
/api/contacts/people/search
200

OK

Last updated

Was this helpful?