Directory API: People

Retrieves one specific person

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

personstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/directory/people/{person}

HTTPcURLJavaScriptPython

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

200

OK

{
  "billingAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "homeAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "industryItemId": "123e4567-e89b-12d3-a456-426614174000",
  "membershipStatusItemId": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "occupationStandardId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "personId": "123e4567-e89b-12d3-a456-426614174000",
  "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "workAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "candidateIsActivelySeeking": true,
  "candidateIsWillingToRelocate": true,
  "emailAlternateEnabled": true,
  "emailEnabled": true,
  "isAdministrator": true,
  "isArchived": true,
  "isDeveloper": true,
  "isLearner": true,
  "isOperator": true,
  "marketingEmailEnabled": true,
  "accessRevokedBy": "text",
  "ageGroup": "text",
  "candidateLinkedInUrl": "text",
  "candidateOccupationList": "text",
  "citizenship": "text",
  "consentConsultation": "text",
  "consentToShare": "text",
  "credentialingCountry": "text",
  "educationLevel": "text",
  "emergencyContactName": "text",
  "emergencyContactPhone": "text",
  "emergencyContactRelationship": "text",
  "employeeType": "text",
  "employeeUnion": "text",
  "firstLanguage": "text",
  "fullName": "text",
  "gender": "text",
  "immigrationApplicant": "text",
  "immigrationCategory": "text",
  "immigrationDestination": "text",
  "immigrationDisability": "text",
  "immigrationNumber": "text",
  "jobDivision": "text",
  "jobsApprovedBy": "text",
  "jobTitle": "text",
  "language": "text",
  "personCode": "text",
  "personType": "text",
  "phone": "text",
  "phoneFax": "text",
  "phoneHome": "text",
  "phoneOther": "text",
  "phoneWork": "text",
  "referrer": "text",
  "referrerOther": "text",
  "region": "text",
  "shippingPreference": "text",
  "socialInsuranceNumber": "text",
  "tradeworkerNumber": "text",
  "userAccessGrantedBy": "text",
  "userApproveReason": "text",
  "webSiteUrl": "text",
  "candidateCompletionProfilePercent": 1,
  "candidateCompletionResumePercent": 1,
  "customKey": 1,
  "welcomeEmailsSentToUser": 1,
  "accessRevoked": "2026-01-29T13:57:01.808Z",
  "accountReviewCompleted": "2026-01-29T13:57:01.808Z",
  "accountReviewQueued": "2026-01-29T13:57:01.808Z",
  "created": "2026-01-29T13:57:01.808Z",
  "jobsApproved": "2026-01-29T13:57:01.808Z",
  "lastAuthenticated": "2026-01-29T13:57:01.808Z",
  "modified": "2026-01-29T13:57:01.808Z",
  "sinModified": "2026-01-29T13:57:01.808Z",
  "userAccessGranted": "2026-01-29T13:57:01.808Z",
  "whenArchived": "2026-01-29T13:57:01.808Z",
  "whenUnarchived": "2026-01-29T13:57:01.808Z",
  "birthdate": "2026-01-29T13:57:01.808Z",
  "immigrationLandingDate": "2026-01-29T13:57:01.808Z",
  "memberEndDate": "2026-01-29T13:57:01.808Z",
  "memberStartDate": "2026-01-29T13:57:01.808Z"
}

Checks for the existence of one specific person

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

personstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/directory/people/{person}

HTTPcURLJavaScriptPython

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

200

OK

true

Collects the list of people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

emailExactstring · nullableOptional

eventRolestring · nullableOptional

fullNamestring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/directory/people/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T13:57:01.808Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "emailExact": "text",
  "eventRole": "text",
  "fullName": "text"
}

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

200

OK

[
  {
    "billingAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "homeAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "industryItemId": "123e4567-e89b-12d3-a456-426614174000",
    "membershipStatusItemId": "123e4567-e89b-12d3-a456-426614174000",
    "modifiedBy": "123e4567-e89b-12d3-a456-426614174000",
    "occupationStandardId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "personId": "123e4567-e89b-12d3-a456-426614174000",
    "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "workAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "candidateIsActivelySeeking": true,
    "candidateIsWillingToRelocate": true,
    "emailAlternateEnabled": true,
    "emailEnabled": true,
    "isAdministrator": true,
    "isArchived": true,
    "isDeveloper": true,
    "isLearner": true,
    "isOperator": true,
    "marketingEmailEnabled": true,
    "accessRevokedBy": "text",
    "ageGroup": "text",
    "candidateLinkedInUrl": "text",
    "candidateOccupationList": "text",
    "citizenship": "text",
    "consentConsultation": "text",
    "consentToShare": "text",
    "credentialingCountry": "text",
    "educationLevel": "text",
    "emergencyContactName": "text",
    "emergencyContactPhone": "text",
    "emergencyContactRelationship": "text",
    "employeeType": "text",
    "employeeUnion": "text",
    "firstLanguage": "text",
    "fullName": "text",
    "gender": "text",
    "immigrationApplicant": "text",
    "immigrationCategory": "text",
    "immigrationDestination": "text",
    "immigrationDisability": "text",
    "immigrationNumber": "text",
    "jobDivision": "text",
    "jobsApprovedBy": "text",
    "jobTitle": "text",
    "language": "text",
    "personCode": "text",
    "personType": "text",
    "phone": "text",
    "phoneFax": "text",
    "phoneHome": "text",
    "phoneOther": "text",
    "phoneWork": "text",
    "referrer": "text",
    "referrerOther": "text",
    "region": "text",
    "shippingPreference": "text",
    "socialInsuranceNumber": "text",
    "tradeworkerNumber": "text",
    "userAccessGrantedBy": "text",
    "userApproveReason": "text",
    "webSiteUrl": "text",
    "candidateCompletionProfilePercent": 1,
    "candidateCompletionResumePercent": 1,
    "customKey": 1,
    "welcomeEmailsSentToUser": 1,
    "accessRevoked": "2026-01-29T13:57:01.808Z",
    "accountReviewCompleted": "2026-01-29T13:57:01.808Z",
    "accountReviewQueued": "2026-01-29T13:57:01.808Z",
    "created": "2026-01-29T13:57:01.808Z",
    "jobsApproved": "2026-01-29T13:57:01.808Z",
    "lastAuthenticated": "2026-01-29T13:57:01.808Z",
    "modified": "2026-01-29T13:57:01.808Z",
    "sinModified": "2026-01-29T13:57:01.808Z",
    "userAccessGranted": "2026-01-29T13:57:01.808Z",
    "whenArchived": "2026-01-29T13:57:01.808Z",
    "whenUnarchived": "2026-01-29T13:57:01.808Z",
    "birthdate": "2026-01-29T13:57:01.808Z",
    "immigrationLandingDate": "2026-01-29T13:57:01.808Z",
    "memberEndDate": "2026-01-29T13:57:01.808Z",
    "memberStartDate": "2026-01-29T13:57:01.808Z"
  }
]

Counts the people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

emailExactstring · nullableOptional

eventRolestring · nullableOptional

fullNamestring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/directory/people/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T13:57:01.808Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "emailExact": "text",
  "eventRole": "text",
  "fullName": "text"
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

emailExactstring · nullableOptional

eventRolestring · nullableOptional

fullNamestring · nullableOptional

Responses

200

OK

No content

post

/api/directory/people/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T13:57:01.808Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "emailExact": "text",
  "eventRole": "text",
  "fullName": "text"
}

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

200

OK

No content

Searches for the list of people that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

emailExactstring · nullableOptional

eventRolestring · nullableOptional

fullNamestring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/directory/people/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T13:57:01.808Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "emailExact": "text",
  "eventRole": "text",
  "fullName": "text"
}

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

200

OK

[
  {
    "personId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "userName": "text",
    "userEmail": "text",
    "isAdministrator": true,
    "isDeveloper": true,
    "isOperator": true,
    "isLearner": true,
    "timeZone": "text"
  }
]