Contacts API: People

Retrieves one specific pending person

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pendingstring · uuidRequired

Responses

200

OK

application/jsontext/json

PendingPersonIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

GroupIdentifierstring · uuid · nullableOptional

SubmittedBystring · uuidOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

UserMiddleNamestring · nullableOptional

JobDivisionstring · nullableOptional

JobTitlestring · nullableOptional

WorkAddressStreet1string · nullableOptional

WorkAddressStreet2string · nullableOptional

WorkAddressCitystring · nullableOptional

WorkAddressProvincestring · nullableOptional

WorkAddressPostalCodestring · nullableOptional

EmployeeStatusstring · nullableOptional

SubmittedAtstring · date-timeOptional

404

Not Found

application/jsontext/json

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

HTTPcURLJavaScriptPython

GET /v2/e01/api/contacts/pending-people/{pending} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "PendingPersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text",
  "UserMiddleName": "text",
  "JobDivision": "text",
  "JobTitle": "text",
  "WorkAddressStreet1": "text",
  "WorkAddressStreet2": "text",
  "WorkAddressCity": "text",
  "WorkAddressProvince": "text",
  "WorkAddressPostalCode": "text",
  "EmployeeStatus": "text",
  "SubmittedAt": "2026-08-10T02:42:36.573Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pendingstring · uuidRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

PendingPersonIdentifierstring · uuidOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/jsontext/json

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

HTTPcURLJavaScriptPython

PUT /v2/e01/api/contacts/pending-people/{pending} HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 150

{
  "PendingPersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pendingstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

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

HTTPcURLJavaScriptPython

DELETE /v2/e01/api/contacts/pending-people/{pending} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Checks for the existence of one specific pending person

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

pendingstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

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

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/contacts/pending-people/{pending} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of pending people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

SubmittedBystring · uuid · nullableOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

SubmittedBeforestring · date-time · nullableOptional

SubmittedSincestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

PendingPersonIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

GroupIdentifierstring · uuid · nullableOptional

SubmittedBystring · uuidOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

UserMiddleNamestring · nullableOptional

JobDivisionstring · nullableOptional

JobTitlestring · nullableOptional

WorkAddressStreet1string · nullableOptional

WorkAddressStreet2string · nullableOptional

WorkAddressCitystring · nullableOptional

WorkAddressProvincestring · nullableOptional

WorkAddressPostalCodestring · nullableOptional

EmployeeStatusstring · nullableOptional

SubmittedAtstring · date-timeOptional

post/api/contacts/pending-people/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/pending-people/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 227

{
  "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text",
  "SubmittedBefore": "2026-08-10T02:42:36.573Z",
  "SubmittedSince": "2026-08-10T02:42:36.573Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "PendingPersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
    "PersonCode": "text",
    "UserEmail": "text",
    "UserFirstName": "text",
    "UserLastName": "text",
    "UserMiddleName": "text",
    "JobDivision": "text",
    "JobTitle": "text",
    "WorkAddressStreet1": "text",
    "WorkAddressStreet2": "text",
    "WorkAddressCity": "text",
    "WorkAddressProvince": "text",
    "WorkAddressPostalCode": "text",
    "EmployeeStatus": "text",
    "SubmittedAt": "2026-08-10T02:42:36.573Z"
  }
]

Counts the pending people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

SubmittedBystring · uuid · nullableOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

SubmittedBeforestring · date-time · nullableOptional

SubmittedSincestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/contacts/pending-people/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/pending-people/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 227

{
  "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text",
  "SubmittedBefore": "2026-08-10T02:42:36.573Z",
  "SubmittedSince": "2026-08-10T02:42:36.573Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of pending people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

SubmittedBystring · uuid · nullableOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

SubmittedBeforestring · date-time · nullableOptional

SubmittedSincestring · date-time · nullableOptional

Responses

200

OK

No content

post/api/contacts/pending-people/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/pending-people/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 227

{
  "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text",
  "SubmittedBefore": "2026-08-10T02:42:36.573Z",
  "SubmittedSince": "2026-08-10T02:42:36.573Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of pending people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

SubmittedBystring · uuid · nullableOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

SubmittedBeforestring · date-time · nullableOptional

SubmittedSincestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

PendingPersonIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

GroupIdentifierstring · uuid · nullableOptional

SubmittedBystring · uuidOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

UserMiddleNamestring · nullableOptional

JobDivisionstring · nullableOptional

JobTitlestring · nullableOptional

WorkAddressStreet1string · nullableOptional

WorkAddressStreet2string · nullableOptional

WorkAddressCitystring · nullableOptional

WorkAddressProvincestring · nullableOptional

WorkAddressPostalCodestring · nullableOptional

EmployeeStatusstring · nullableOptional

SubmittedAtstring · date-timeOptional

post/api/contacts/pending-people/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/pending-people/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 227

{
  "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text",
  "SubmittedBefore": "2026-08-10T02:42:36.573Z",
  "SubmittedSince": "2026-08-10T02:42:36.573Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "PendingPersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
    "PersonCode": "text",
    "UserEmail": "text",
    "UserFirstName": "text",
    "UserLastName": "text",
    "UserMiddleName": "text",
    "JobDivision": "text",
    "JobTitle": "text",
    "WorkAddressStreet1": "text",
    "WorkAddressStreet2": "text",
    "WorkAddressCity": "text",
    "WorkAddressProvince": "text",
    "WorkAddressPostalCode": "text",
    "EmployeeStatus": "text",
    "SubmittedAt": "2026-08-10T02:42:36.573Z"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

PersonCodestring · min: 1Required

UserEmailstring · min: 1Required

UserFirstNamestring · min: 1Required

UserLastNamestring · min: 1Required

EmployeeStatusstring · min: 1Required

Responses

201

Created

application/json

PendingPersonIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

GroupIdentifierstring · uuid · nullableOptional

SubmittedBystring · uuidOptional

PersonCodestring · nullableOptional

UserEmailstring · nullableOptional

UserFirstNamestring · nullableOptional

UserLastNamestring · nullableOptional

UserMiddleNamestring · nullableOptional

JobDivisionstring · nullableOptional

JobTitlestring · nullableOptional

WorkAddressStreet1string · nullableOptional

WorkAddressStreet2string · nullableOptional

WorkAddressCitystring · nullableOptional

WorkAddressProvincestring · nullableOptional

WorkAddressPostalCodestring · nullableOptional

EmployeeStatusstring · nullableOptional

SubmittedAtstring · date-timeOptional

400

Bad Request

application/json

post/api/contacts/pending-people

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/pending-people HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 109

{
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text",
  "EmployeeStatus": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "PendingPersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SubmittedBy": "123e4567-e89b-12d3-a456-426614174000",
  "PersonCode": "text",
  "UserEmail": "text",
  "UserFirstName": "text",
  "UserLastName": "text",
  "UserMiddleName": "text",
  "JobDivision": "text",
  "JobTitle": "text",
  "WorkAddressStreet1": "text",
  "WorkAddressStreet2": "text",
  "WorkAddressCity": "text",
  "WorkAddressProvince": "text",
  "WorkAddressPostalCode": "text",
  "EmployeeStatus": "text",
  "SubmittedAt": "2026-08-10T02:42:36.573Z"
}

Retrieves one specific person

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

personstring · uuidRequired

Responses

200

OK

application/jsontext/json

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

LastChangeTimestring · date-timeOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · uuidOptional

404

Not Found

application/jsontext/json

get/api/contacts/people/{person}

HTTPcURLJavaScriptPython

GET /v2/e01/api/contacts/people/{person} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "FullName": "text",
  "PersonFirstName": "text",
  "PersonMiddleName": "text",
  "PersonLastName": "text",
  "PersonType": "text",
  "PersonCode": "text",
  "PersonId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "UserName": "text",
  "UserEmail": "text",
  "UserEmailAlternate": "text",
  "IsAdministrator": true,
  "IsDeveloper": true,
  "IsLearner": true,
  "IsOperator": true,
  "AccessRevoked": "2026-08-10T02:42:36.573Z",
  "AccessRevokedBy": "text",
  "LastAuthenticated": "2026-08-10T02:42:36.573Z",
  "UserAccessGranted": "2026-08-10T02:42:36.573Z",
  "UserAccessGrantedBy": "text",
  "UserApproveReason": "text",
  "WelcomeEmailsSentToUser": 1,
  "EmailAlternateEnabled": true,
  "EmailEnabled": true,
  "MarketingEmailEnabled": true,
  "Phone": "text",
  "PhoneFax": "text",
  "PhoneHome": "text",
  "PhoneOther": "text",
  "PhoneWork": "text",
  "BillingAddress": {
    "AddressId": "123e4567-e89b-12d3-a456-426614174000",
    "City": "text",
    "Country": "text",
    "Description": "text",
    "PostalCode": "text",
    "Province": "text",
    "Street1": "text",
    "Street2": "text"
  },
  "HomeAddress": {
    "AddressId": "123e4567-e89b-12d3-a456-426614174000",
    "City": "text",
    "Country": "text",
    "Description": "text",
    "PostalCode": "text",
    "Province": "text",
    "Street1": "text",
    "Street2": "text"
  },
  "ShippingAddress": {
    "AddressId": "123e4567-e89b-12d3-a456-426614174000",
    "City": "text",
    "Country": "text",
    "Description": "text",
    "PostalCode": "text",
    "Province": "text",
    "Street1": "text",
    "Street2": "text"
  },
  "ShippingPreference": "text",
  "WorkAddress": {
    "AddressId": "123e4567-e89b-12d3-a456-426614174000",
    "City": "text",
    "Country": "text",
    "Description": "text",
    "PostalCode": "text",
    "Province": "text",
    "Street1": "text",
    "Street2": "text"
  },
  "EmergencyContactName": "text",
  "EmergencyContactPhone": "text",
  "EmergencyContactRelationship": "text",
  "AgeGroup": "text",
  "Birthdate": "2026-08-10T02:42:36.573Z",
  "Citizenship": "text",
  "FirstLanguage": "text",
  "Gender": "text",
  "Language": "text",
  "Region": "text",
  "TimeZone": "text",
  "EmployerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "EmployeeType": "text",
  "EmployeeUnion": "text",
  "JobDivision": "text",
  "JobTitle": "text",
  "JobsApproved": "2026-08-10T02:42:36.573Z",
  "JobsApprovedBy": "text",
  "OccupationStandardId": "123e4567-e89b-12d3-a456-426614174000",
  "CandidateCompletionProfilePercent": 1,
  "CandidateCompletionResumePercent": 1,
  "CandidateIsActivelySeeking": true,
  "CandidateIsWillingToRelocate": true,
  "CandidateLinkedInUrl": "text",
  "CandidateOccupationList": "text",
  "ImmigrationApplicant": "text",
  "ImmigrationCategory": "text",
  "ImmigrationDestination": "text",
  "ImmigrationDisability": "text",
  "ImmigrationLandingDate": "2026-08-10T02:42:36.573Z",
  "ImmigrationNumber": "text",
  "MemberEndDate": "2026-08-10T02:42:36.573Z",
  "MembershipStatusItemId": "123e4567-e89b-12d3-a456-426614174000",
  "MemberStartDate": "2026-08-10T02:42:36.573Z",
  "CredentialingCountry": "text",
  "EducationLevel": "text",
  "IndustryItemId": "123e4567-e89b-12d3-a456-426614174000",
  "SocialInsuranceNumber": "text",
  "TradeworkerNumber": "text",
  "ConsentConsultation": "text",
  "ConsentToShare": "text",
  "Referrer": "text",
  "ReferrerOther": "text",
  "IsArchived": true,
  "WhenArchived": "2026-08-10T02:42:36.573Z",
  "WhenUnarchived": "2026-08-10T02:42:36.573Z",
  "AccountReviewCompleted": "2026-08-10T02:42:36.573Z",
  "AccountReviewQueued": "2026-08-10T02:42:36.573Z",
  "WebSiteUrl": "text",
  "Created": "2026-08-10T02:42:36.573Z",
  "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "CustomKey": 1,
  "Modified": "2026-08-10T02:42:36.573Z",
  "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "SinModified": "2026-08-10T02:42:36.573Z",
  "LastChangeTime": "2026-08-10T02:42:36.573Z",
  "LastChangeType": "text",
  "LastChangeUser": "123e4567-e89b-12d3-a456-426614174000"
}

Checks for the existence of one specific person

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

personstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

head/api/contacts/people/{person}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/contacts/people/{person} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of people that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the result set to people modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

UserIdstring · uuid · nullableOptional

EmailExactstring · nullableOptional

EmailLikestring · nullableOptional

EventRolestring · nullableOptional

FullNamestring · nullableOptional

PersonCodestring · nullableOptional

FirstNameExactstring · nullableOptional

LastNameExactstring · nullableOptional

LastAuthenticatedSincestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsApprovedboolean · nullableOptional

Responses

200

OK

application/jsontext/json

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

LastChangeTimestring · date-timeOptional

LastChangeTypestring · nullableOptional

LastChangeUserstring · uuidOptional

post/api/contacts/people/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/people/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 361

{
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "EmailExact": "text",
  "EmailLike": "text",
  "EventRole": "text",
  "FullName": "text",
  "PersonCode": "text",
  "FirstNameExact": "text",
  "LastNameExact": "text",
  "LastAuthenticatedSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeBefore": "2026-08-10T02:42:36.573Z",
  "IsApproved": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "FullName": "text",
    "PersonFirstName": "text",
    "PersonMiddleName": "text",
    "PersonLastName": "text",
    "PersonType": "text",
    "PersonCode": "text",
    "PersonId": "123e4567-e89b-12d3-a456-426614174000",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "UserName": "text",
    "UserEmail": "text",
    "UserEmailAlternate": "text",
    "IsAdministrator": true,
    "IsDeveloper": true,
    "IsLearner": true,
    "IsOperator": true,
    "AccessRevoked": "2026-08-10T02:42:36.573Z",
    "AccessRevokedBy": "text",
    "LastAuthenticated": "2026-08-10T02:42:36.573Z",
    "UserAccessGranted": "2026-08-10T02:42:36.573Z",
    "UserAccessGrantedBy": "text",
    "UserApproveReason": "text",
    "WelcomeEmailsSentToUser": 1,
    "EmailAlternateEnabled": true,
    "EmailEnabled": true,
    "MarketingEmailEnabled": true,
    "Phone": "text",
    "PhoneFax": "text",
    "PhoneHome": "text",
    "PhoneOther": "text",
    "PhoneWork": "text",
    "BillingAddress": {
      "AddressId": "123e4567-e89b-12d3-a456-426614174000",
      "City": "text",
      "Country": "text",
      "Description": "text",
      "PostalCode": "text",
      "Province": "text",
      "Street1": "text",
      "Street2": "text"
    },
    "HomeAddress": {
      "AddressId": "123e4567-e89b-12d3-a456-426614174000",
      "City": "text",
      "Country": "text",
      "Description": "text",
      "PostalCode": "text",
      "Province": "text",
      "Street1": "text",
      "Street2": "text"
    },
    "ShippingAddress": {
      "AddressId": "123e4567-e89b-12d3-a456-426614174000",
      "City": "text",
      "Country": "text",
      "Description": "text",
      "PostalCode": "text",
      "Province": "text",
      "Street1": "text",
      "Street2": "text"
    },
    "ShippingPreference": "text",
    "WorkAddress": {
      "AddressId": "123e4567-e89b-12d3-a456-426614174000",
      "City": "text",
      "Country": "text",
      "Description": "text",
      "PostalCode": "text",
      "Province": "text",
      "Street1": "text",
      "Street2": "text"
    },
    "EmergencyContactName": "text",
    "EmergencyContactPhone": "text",
    "EmergencyContactRelationship": "text",
    "AgeGroup": "text",
    "Birthdate": "2026-08-10T02:42:36.573Z",
    "Citizenship": "text",
    "FirstLanguage": "text",
    "Gender": "text",
    "Language": "text",
    "Region": "text",
    "TimeZone": "text",
    "EmployerGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "EmployeeType": "text",
    "EmployeeUnion": "text",
    "JobDivision": "text",
    "JobTitle": "text",
    "JobsApproved": "2026-08-10T02:42:36.573Z",
    "JobsApprovedBy": "text",
    "OccupationStandardId": "123e4567-e89b-12d3-a456-426614174000",
    "CandidateCompletionProfilePercent": 1,
    "CandidateCompletionResumePercent": 1,
    "CandidateIsActivelySeeking": true,
    "CandidateIsWillingToRelocate": true,
    "CandidateLinkedInUrl": "text",
    "CandidateOccupationList": "text",
    "ImmigrationApplicant": "text",
    "ImmigrationCategory": "text",
    "ImmigrationDestination": "text",
    "ImmigrationDisability": "text",
    "ImmigrationLandingDate": "2026-08-10T02:42:36.573Z",
    "ImmigrationNumber": "text",
    "MemberEndDate": "2026-08-10T02:42:36.573Z",
    "MembershipStatusItemId": "123e4567-e89b-12d3-a456-426614174000",
    "MemberStartDate": "2026-08-10T02:42:36.573Z",
    "CredentialingCountry": "text",
    "EducationLevel": "text",
    "IndustryItemId": "123e4567-e89b-12d3-a456-426614174000",
    "SocialInsuranceNumber": "text",
    "TradeworkerNumber": "text",
    "ConsentConsultation": "text",
    "ConsentToShare": "text",
    "Referrer": "text",
    "ReferrerOther": "text",
    "IsArchived": true,
    "WhenArchived": "2026-08-10T02:42:36.573Z",
    "WhenUnarchived": "2026-08-10T02:42:36.573Z",
    "AccountReviewCompleted": "2026-08-10T02:42:36.573Z",
    "AccountReviewQueued": "2026-08-10T02:42:36.573Z",
    "WebSiteUrl": "text",
    "Created": "2026-08-10T02:42:36.573Z",
    "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "CustomKey": 1,
    "Modified": "2026-08-10T02:42:36.573Z",
    "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
    "SinModified": "2026-08-10T02:42:36.573Z",
    "LastChangeTime": "2026-08-10T02:42:36.573Z",
    "LastChangeType": "text",
    "LastChangeUser": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Counts the people that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the count to people modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

UserIdstring · uuid · nullableOptional

EmailExactstring · nullableOptional

EmailLikestring · nullableOptional

EventRolestring · nullableOptional

FullNamestring · nullableOptional

PersonCodestring · nullableOptional

FirstNameExactstring · nullableOptional

LastNameExactstring · nullableOptional

LastAuthenticatedSincestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsApprovedboolean · nullableOptional

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/contacts/people/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/people/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 361

{
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "EmailExact": "text",
  "EmailLike": "text",
  "EventRole": "text",
  "FullName": "text",
  "PersonCode": "text",
  "FirstNameExact": "text",
  "LastNameExact": "text",
  "LastAuthenticatedSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeBefore": "2026-08-10T02:42:36.573Z",
  "IsApproved": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of people that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to download only people modified within a specific window, which is useful for incremental integrations that already hold most of the data. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive. When polling for deltas, subtract a small overlap (for example five minutes) from the previous poll time to allow for projection lag.

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

UserIdstring · uuid · nullableOptional

EmailExactstring · nullableOptional

EmailLikestring · nullableOptional

EventRolestring · nullableOptional

FullNamestring · nullableOptional

PersonCodestring · nullableOptional

FirstNameExactstring · nullableOptional

LastNameExactstring · nullableOptional

LastAuthenticatedSincestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsApprovedboolean · nullableOptional

Responses

200

OK

No content

post/api/contacts/people/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/people/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 361

{
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "EmailExact": "text",
  "EmailLike": "text",
  "EventRole": "text",
  "FullName": "text",
  "PersonCode": "text",
  "FirstNameExact": "text",
  "LastNameExact": "text",
  "LastAuthenticatedSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeBefore": "2026-08-10T02:42:36.573Z",
  "IsApproved": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of people that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the result set to people modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

UserIdstring · uuid · nullableOptional

EmailExactstring · nullableOptional

EmailLikestring · nullableOptional

EventRolestring · nullableOptional

FullNamestring · nullableOptional

PersonCodestring · nullableOptional

FirstNameExactstring · nullableOptional

LastNameExactstring · nullableOptional

LastAuthenticatedSincestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

IsApprovedboolean · nullableOptional

Responses

200

OK

application/jsontext/json

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

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/people/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 361

{
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "EmailExact": "text",
  "EmailLike": "text",
  "EventRole": "text",
  "FullName": "text",
  "PersonCode": "text",
  "FirstNameExact": "text",
  "LastNameExact": "text",
  "LastAuthenticatedSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeSince": "2026-08-10T02:42:36.573Z",
  "LastChangeTimeBefore": "2026-08-10T02:42:36.573Z",
  "IsApproved": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "PersonId": "123e4567-e89b-12d3-a456-426614174000",
    "PersonCode": "text",
    "PersonFirstName": "text",
    "PersonMiddleName": "text",
    "PersonLastName": "text",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "UserName": "text",
    "UserEmail": "text",
    "IsAdministrator": true,
    "IsDeveloper": true,
    "IsLearner": true,
    "IsOperator": true,
    "TimeZone": "text"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Bodyobject · ImportPerson[]

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

PersonCodestring · min: 1 · max: 20Required

UserEmailstring · min: 1 · max: 254Required

UserFirstNamestring · min: 1 · max: 40Required

UserLastNamestring · min: 1 · max: 40Required

UserMiddleNamestring · max: 38 · nullableOptional

JobDivisionstring · max: 100 · nullableOptional

JobTitlestring · max: 256 · nullableOptional

WorkAddressStreet1string · max: 200 · nullableOptional

WorkAddressStreet2string · max: 200 · nullableOptional

WorkAddressCitystring · max: 128 · nullableOptional

WorkAddressProvincestring · max: 64 · nullableOptional

WorkAddressPostalCodestring · max: 20 · nullableOptional

GroupCodestring · nullableOptional

EmployeeStatusstring · enumRequiredPossible values:

Responses

200

OK

application/jsontext/json

ReportFileIdstring · uuid · nullableRequired

ReportFileNamestring · nullableRequired

post/api/contacts/people/import

HTTPcURLJavaScriptPython

POST /v2/e01/api/contacts/people/import HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 336

[
  {
    "PersonCode": "text",
    "UserEmail": "text",
    "UserFirstName": "text",
    "UserLastName": "text",
    "UserMiddleName": "text",
    "JobDivision": "text",
    "JobTitle": "text",
    "WorkAddressStreet1": "text",
    "WorkAddressStreet2": "text",
    "WorkAddressCity": "text",
    "WorkAddressProvince": "text",
    "WorkAddressPostalCode": "text",
    "GroupCode": "text",
    "EmployeeStatus": "Active"
  }
]

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "ReportFileId": "123e4567-e89b-12d3-a456-426614174000",
  "ReportFileName": "text",
  "ImportedPeople": [
    {
      "PersonCode": "text",
      "Status": "Modified",
      "PendingPersonId": "123e4567-e89b-12d3-a456-426614174000",
      "UserId": "123e4567-e89b-12d3-a456-426614174000",
      "Failure": {
        "Errors": [
          {
            "Type": "text",
            "Title": "text",
            "Status": 1,
            "Detail": "text",
            "Instance": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ]
      }
    }
  ]
}