Directory: People | Shift iQ Docs

get

Authorizations

Path parameters

addressstring · uuidRequired

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-addresses/{address} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "AddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "City": "text",
  "Country": "text",
  "Description": "text",
  "PostalCode": "text",
  "Province": "text",
  "Street1": "text",
  "Street2": "text"
}

head

Authorizations

Path parameters

addressstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HEAD /v2/E01/directory/people-addresses/{address} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

Query parameters

CitystringOptional

CountrystringOptional

DescriptionstringOptional

PostalCodestringOptional

ProvincestringOptional

Street1stringOptional

Street2stringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

GET /v2/E01/directory/people-addresses/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

get

Authorizations

Query parameters

CitystringOptional

CountrystringOptional

DescriptionstringOptional

PostalCodestringOptional

ProvincestringOptional

Street1stringOptional

Street2stringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-addresses HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "AddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "City": "text",
    "Country": "text",
    "Description": "text",
    "PostalCode": "text",
    "Province": "text",
    "Street1": "text",
    "Street2": "text"
  }
]

get

Authorizations

Query parameters

CitystringOptional

CountrystringOptional

DescriptionstringOptional

PostalCodestringOptional

ProvincestringOptional

Street1stringOptional

Street2stringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-addresses/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "AddressIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

Path parameters

personstring · uuidRequired

Responses

200

OK

application/json

get

GET /v2/E01/directory/people/{person} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "BillingAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "EmployerGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "HomeAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "IndustryItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "MembershipStatusItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "OccupationStandardIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ShippingAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "WorkAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "CandidateIsActivelySeeking": true,
  "CandidateIsWillingToRelocate": true,
  "EmailAlternateEnabled": true,
  "EmailEnabled": true,
  "IsAdministrator": true,
  "IsArchived": true,
  "IsLearner": true,
  "IsOperator": true,
  "MarketingEmailEnabled": true,
  "AccessRevokedBy": "text",
  "AccountStatusName": "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",
  "JobsApprovedBy": "text",
  "JobTitle": "text",
  "Language": "text",
  "PersonCode": "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,
  "MembershipStatusItemKey": 1,
  "WelcomeEmailsSentToUser": 1,
  "AccessRevoked": "2025-08-04T01:50:47.585Z",
  "AccountReviewCompleted": "2025-08-04T01:50:47.585Z",
  "AccountReviewQueued": "2025-08-04T01:50:47.585Z",
  "Created": "2025-08-04T01:50:47.585Z",
  "JobsApproved": "2025-08-04T01:50:47.585Z",
  "LastAuthenticated": "2025-08-04T01:50:47.585Z",
  "Modified": "2025-08-04T01:50:47.585Z",
  "UserAccessGranted": "2025-08-04T01:50:47.585Z",
  "WhenArchived": "2025-08-04T01:50:47.585Z",
  "WhenUnarchived": "2025-08-04T01:50:47.585Z",
  "Birthdate": "2025-08-04T01:50:47.585Z",
  "ImmigrationLandingDate": "2025-08-04T01:50:47.585Z",
  "MemberEndDate": "2025-08-04T01:50:47.585Z",
  "MemberStartDate": "2025-08-04T01:50:47.585Z"
}

head

Authorizations

Path parameters

personstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HEAD /v2/E01/directory/people/{person} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

Query parameters

BillingAddressIdentifierstring · uuidOptional

CreatedBystring · uuidOptional

EmployerGroupIdentifierstring · uuidOptional

HomeAddressIdentifierstring · uuidOptional

IndustryItemIdentifierstring · uuidOptional

MembershipStatusItemIdentifierstring · uuidOptional

ModifiedBystring · uuidOptional

OccupationStandardIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

ShippingAddressIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

WorkAddressIdentifierstring · uuidOptional

CandidateIsActivelySeekingbooleanOptional

CandidateIsWillingToRelocatebooleanOptional

EmailAlternateEnabledbooleanOptional

EmailEnabledbooleanOptional

IsAdministratorbooleanOptional

IsArchivedbooleanOptional

IsLearnerbooleanOptional

IsOperatorbooleanOptional

MarketingEmailEnabledbooleanOptional

AccessRevokedBystringOptional

AccountStatusNamestringOptional

CandidateLinkedInUrlstringOptional

CandidateOccupationListstringOptional

CitizenshipstringOptional

ConsentConsultationstringOptional

ConsentToSharestringOptional

CredentialingCountrystringOptional

EducationLevelstringOptional

EmergencyContactNamestringOptional

EmergencyContactPhonestringOptional

EmergencyContactRelationshipstringOptional

EmployeeUnionstringOptional

FirstLanguagestringOptional

FullNamestringOptional

GenderstringOptional

ImmigrationApplicantstringOptional

ImmigrationCategorystringOptional

ImmigrationDestinationstringOptional

ImmigrationDisabilitystringOptional

ImmigrationNumberstringOptional

JobsApprovedBystringOptional

JobTitlestringOptional

LanguagestringOptional

PersonCodestringOptional

PhonestringOptional

PhoneFaxstringOptional

PhoneHomestringOptional

PhoneOtherstringOptional

PhoneWorkstringOptional

ReferrerstringOptional

ReferrerOtherstringOptional

RegionstringOptional

ShippingPreferencestringOptional

SocialInsuranceNumberstringOptional

TradeworkerNumberstringOptional

UserAccessGrantedBystringOptional

UserApproveReasonstringOptional

WebSiteUrlstringOptional

CandidateCompletionProfilePercentinteger · int32Optional

CandidateCompletionResumePercentinteger · int32Optional

CustomKeyinteger · int32Optional

MembershipStatusItemKeyinteger · int32Optional

WelcomeEmailsSentToUserinteger · int32Optional

AccessRevokedstring · date-timeOptional

AccountReviewCompletedstring · date-timeOptional

AccountReviewQueuedstring · date-timeOptional

Createdstring · date-timeOptional

JobsApprovedstring · date-timeOptional

LastAuthenticatedstring · date-timeOptional

Modifiedstring · date-timeOptional

UserAccessGrantedstring · date-timeOptional

WhenArchivedstring · date-timeOptional

WhenUnarchivedstring · date-timeOptional

Birthdatestring · date-timeOptional

ImmigrationLandingDatestring · date-timeOptional

MemberEndDatestring · date-timeOptional

MemberStartDatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

GET /v2/E01/directory/people/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

get

Authorizations

Query parameters

BillingAddressIdentifierstring · uuidOptional

CreatedBystring · uuidOptional

EmployerGroupIdentifierstring · uuidOptional

HomeAddressIdentifierstring · uuidOptional

IndustryItemIdentifierstring · uuidOptional

MembershipStatusItemIdentifierstring · uuidOptional

ModifiedBystring · uuidOptional

OccupationStandardIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

ShippingAddressIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

WorkAddressIdentifierstring · uuidOptional

CandidateIsActivelySeekingbooleanOptional

CandidateIsWillingToRelocatebooleanOptional

EmailAlternateEnabledbooleanOptional

EmailEnabledbooleanOptional

IsAdministratorbooleanOptional

IsArchivedbooleanOptional

IsLearnerbooleanOptional

IsOperatorbooleanOptional

MarketingEmailEnabledbooleanOptional

AccessRevokedBystringOptional

AccountStatusNamestringOptional

CandidateLinkedInUrlstringOptional

CandidateOccupationListstringOptional

CitizenshipstringOptional

ConsentConsultationstringOptional

ConsentToSharestringOptional

CredentialingCountrystringOptional

EducationLevelstringOptional

EmergencyContactNamestringOptional

EmergencyContactPhonestringOptional

EmergencyContactRelationshipstringOptional

EmployeeUnionstringOptional

FirstLanguagestringOptional

FullNamestringOptional

GenderstringOptional

ImmigrationApplicantstringOptional

ImmigrationCategorystringOptional

ImmigrationDestinationstringOptional

ImmigrationDisabilitystringOptional

ImmigrationNumberstringOptional

JobsApprovedBystringOptional

JobTitlestringOptional

LanguagestringOptional

PersonCodestringOptional

PhonestringOptional

PhoneFaxstringOptional

PhoneHomestringOptional

PhoneOtherstringOptional

PhoneWorkstringOptional

ReferrerstringOptional

ReferrerOtherstringOptional

RegionstringOptional

ShippingPreferencestringOptional

SocialInsuranceNumberstringOptional

TradeworkerNumberstringOptional

UserAccessGrantedBystringOptional

UserApproveReasonstringOptional

WebSiteUrlstringOptional

CandidateCompletionProfilePercentinteger · int32Optional

CandidateCompletionResumePercentinteger · int32Optional

CustomKeyinteger · int32Optional

MembershipStatusItemKeyinteger · int32Optional

WelcomeEmailsSentToUserinteger · int32Optional

AccessRevokedstring · date-timeOptional

AccountReviewCompletedstring · date-timeOptional

AccountReviewQueuedstring · date-timeOptional

Createdstring · date-timeOptional

JobsApprovedstring · date-timeOptional

LastAuthenticatedstring · date-timeOptional

Modifiedstring · date-timeOptional

UserAccessGrantedstring · date-timeOptional

WhenArchivedstring · date-timeOptional

WhenUnarchivedstring · date-timeOptional

Birthdatestring · date-timeOptional

ImmigrationLandingDatestring · date-timeOptional

MemberEndDatestring · date-timeOptional

MemberStartDatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "BillingAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "EmployerGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "HomeAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "IndustryItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "MembershipStatusItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
    "OccupationStandardIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "ShippingAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "WorkAddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "CandidateIsActivelySeeking": true,
    "CandidateIsWillingToRelocate": true,
    "EmailAlternateEnabled": true,
    "EmailEnabled": true,
    "IsAdministrator": true,
    "IsArchived": true,
    "IsLearner": true,
    "IsOperator": true,
    "MarketingEmailEnabled": true,
    "AccessRevokedBy": "text",
    "AccountStatusName": "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",
    "JobsApprovedBy": "text",
    "JobTitle": "text",
    "Language": "text",
    "PersonCode": "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,
    "MembershipStatusItemKey": 1,
    "WelcomeEmailsSentToUser": 1,
    "AccessRevoked": "2025-08-04T01:50:47.585Z",
    "AccountReviewCompleted": "2025-08-04T01:50:47.585Z",
    "AccountReviewQueued": "2025-08-04T01:50:47.585Z",
    "Created": "2025-08-04T01:50:47.585Z",
    "JobsApproved": "2025-08-04T01:50:47.585Z",
    "LastAuthenticated": "2025-08-04T01:50:47.585Z",
    "Modified": "2025-08-04T01:50:47.585Z",
    "UserAccessGranted": "2025-08-04T01:50:47.585Z",
    "WhenArchived": "2025-08-04T01:50:47.585Z",
    "WhenUnarchived": "2025-08-04T01:50:47.585Z",
    "Birthdate": "2025-08-04T01:50:47.585Z",
    "ImmigrationLandingDate": "2025-08-04T01:50:47.585Z",
    "MemberEndDate": "2025-08-04T01:50:47.585Z",
    "MemberStartDate": "2025-08-04T01:50:47.585Z"
  }
]

get

Authorizations

Query parameters

BillingAddressIdentifierstring · uuidOptional

CreatedBystring · uuidOptional

EmployerGroupIdentifierstring · uuidOptional

HomeAddressIdentifierstring · uuidOptional

IndustryItemIdentifierstring · uuidOptional

MembershipStatusItemIdentifierstring · uuidOptional

ModifiedBystring · uuidOptional

OccupationStandardIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

ShippingAddressIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

WorkAddressIdentifierstring · uuidOptional

CandidateIsActivelySeekingbooleanOptional

CandidateIsWillingToRelocatebooleanOptional

EmailAlternateEnabledbooleanOptional

EmailEnabledbooleanOptional

IsAdministratorbooleanOptional

IsArchivedbooleanOptional

IsLearnerbooleanOptional

IsOperatorbooleanOptional

MarketingEmailEnabledbooleanOptional

AccessRevokedBystringOptional

AccountStatusNamestringOptional

CandidateLinkedInUrlstringOptional

CandidateOccupationListstringOptional

CitizenshipstringOptional

ConsentConsultationstringOptional

ConsentToSharestringOptional

CredentialingCountrystringOptional

EducationLevelstringOptional

EmergencyContactNamestringOptional

EmergencyContactPhonestringOptional

EmergencyContactRelationshipstringOptional

EmployeeUnionstringOptional

FirstLanguagestringOptional

FullNamestringOptional

GenderstringOptional

ImmigrationApplicantstringOptional

ImmigrationCategorystringOptional

ImmigrationDestinationstringOptional

ImmigrationDisabilitystringOptional

ImmigrationNumberstringOptional

JobsApprovedBystringOptional

JobTitlestringOptional

LanguagestringOptional

PersonCodestringOptional

PhonestringOptional

PhoneFaxstringOptional

PhoneHomestringOptional

PhoneOtherstringOptional

PhoneWorkstringOptional

ReferrerstringOptional

ReferrerOtherstringOptional

RegionstringOptional

ShippingPreferencestringOptional

SocialInsuranceNumberstringOptional

TradeworkerNumberstringOptional

UserAccessGrantedBystringOptional

UserApproveReasonstringOptional

WebSiteUrlstringOptional

CandidateCompletionProfilePercentinteger · int32Optional

CandidateCompletionResumePercentinteger · int32Optional

CustomKeyinteger · int32Optional

MembershipStatusItemKeyinteger · int32Optional

WelcomeEmailsSentToUserinteger · int32Optional

AccessRevokedstring · date-timeOptional

AccountReviewCompletedstring · date-timeOptional

AccountReviewQueuedstring · date-timeOptional

Createdstring · date-timeOptional

JobsApprovedstring · date-timeOptional

LastAuthenticatedstring · date-timeOptional

Modifiedstring · date-timeOptional

UserAccessGrantedstring · date-timeOptional

WhenArchivedstring · date-timeOptional

WhenUnarchivedstring · date-timeOptional

Birthdatestring · date-timeOptional

ImmigrationLandingDatestring · date-timeOptional

MemberEndDatestring · date-timeOptional

MemberStartDatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

Path parameters

fieldstring · uuidRequired

settingstringRequired

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "FieldIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "FieldName": "text",
  "FieldValue": "text",
  "FieldSequence": 1
}

put

Authorizations

Path parameters

settingstringRequired

Body

FieldIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

FieldNamestring | nullableOptional

FieldValuestring | nullableOptional

FieldSequenceinteger · int32 | nullableOptional

Responses

200

OK

400

Bad Request

application/json

404

Not Found

put

PUT /v2/E01/directory/people-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "FieldIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "FieldName": "text",
  "FieldValue": "text",
  "FieldSequence": 1
}

No content

delete

Authorizations

Path parameters

fieldstring · uuidRequired

settingstringRequired

Responses

200

OK

404

Not Found

delete

DELETE /v2/E01/directory/people-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

Path parameters

fieldstring · uuidRequired

settingstringRequired

Responses

200

OK

application/json

Responseboolean

head

HEAD /v2/E01/directory/people-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

FieldNamestringOptional

FieldValuestringOptional

FieldSequenceinteger · int32Optional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

GET /v2/E01/directory/people-fields/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

get

Authorizations

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

FieldNamestringOptional

FieldValuestringOptional

FieldSequenceinteger · int32Optional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "FieldIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "FieldName": "text",
    "FieldValue": "text",
    "FieldSequence": 1
  }
]

post

Authorizations

Body

FieldIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

FieldNamestring | nullableOptional

FieldValuestring | nullableOptional

FieldSequenceinteger · int32 | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

POST /v2/E01/directory/people-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "FieldIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "FieldName": "text",
  "FieldValue": "text",
  "FieldSequence": 1
}

{
  "FieldIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "FieldName": "text",
  "FieldValue": "text",
  "FieldSequence": 1
}

get

Authorizations

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

FieldNamestringOptional

FieldValuestringOptional

FieldSequenceinteger · int32Optional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-fields/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "FieldIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

Path parameters

secretstring · uuidRequired

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-secrets/{secret} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretName": "text",
  "SecretType": "text",
  "SecretValue": "text",
  "SecretLifetimeLimit": 1,
  "SecretExpiry": "2025-08-04T01:50:47.585Z"
}

put

Authorizations

Path parameters

secretstringRequired

Body

PersonIdentifierstring · uuidOptional

SecretIdentifierstring · uuidOptional

SecretNamestring | nullableOptional

SecretTypestring | nullableOptional

SecretValuestring | nullableOptional

SecretLifetimeLimitinteger · int32 | nullableOptional

SecretExpirystring · date-timeOptional

Responses

200

OK

400

Bad Request

application/json

404

Not Found

put

PUT /v2/E01/directory/people-secrets/{secret} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretName": "text",
  "SecretType": "text",
  "SecretValue": "text",
  "SecretLifetimeLimit": 1,
  "SecretExpiry": "2025-08-04T01:50:47.585Z"
}

No content

delete

Authorizations

Path parameters

secretstring · uuidRequired

Responses

200

OK

404

Not Found

delete

DELETE /v2/E01/directory/people-secrets/{secret} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

Path parameters

secretstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HEAD /v2/E01/directory/people-secrets/{secret} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

Query parameters

PersonIdentifierstring · uuidOptional

SecretNamestringOptional

SecretTypestringOptional

SecretValuestringOptional

SecretLifetimeLimitinteger · int32Optional

SecretExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

GET /v2/E01/directory/people-secrets/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

get

Authorizations

Query parameters

PersonIdentifierstring · uuidOptional

SecretNamestringOptional

SecretTypestringOptional

SecretValuestringOptional

SecretLifetimeLimitinteger · int32Optional

SecretExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-secrets HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "SecretIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "SecretName": "text",
    "SecretType": "text",
    "SecretValue": "text",
    "SecretLifetimeLimit": 1,
    "SecretExpiry": "2025-08-04T01:50:47.585Z"
  }
]

post

Authorizations

Body

PersonIdentifierstring · uuidOptional

SecretIdentifierstring · uuidOptional

SecretNamestring | nullableOptional

SecretTypestring | nullableOptional

SecretValuestring | nullableOptional

SecretLifetimeLimitinteger · int32 | nullableOptional

SecretExpirystring · date-timeOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

POST /v2/E01/directory/people-secrets HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretName": "text",
  "SecretType": "text",
  "SecretValue": "text",
  "SecretLifetimeLimit": 1,
  "SecretExpiry": "2025-08-04T01:50:47.585Z"
}

{
  "PersonIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SecretName": "text",
  "SecretType": "text",
  "SecretValue": "text",
  "SecretLifetimeLimit": 1,
  "SecretExpiry": "2025-08-04T01:50:47.585Z"
}

get

Authorizations

Query parameters

PersonIdentifierstring · uuidOptional

SecretNamestringOptional

SecretTypestringOptional

SecretValuestringOptional

SecretLifetimeLimitinteger · int32Optional

SecretExpirystring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

GET /v2/E01/directory/people-secrets/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "SecretIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]