Relationships API

query fields name returns description info docid 6wsl7ojzng jza bejcmf n/a mypathstoperson docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect the current user to a given person, ordered by the overall strength of the path mytoppathstoperson docid 6wsl7ojzng jza bejcmf returns a collection of paths that connect the current user to a given person, with 1st degree paths grouped together and 2nd degree paths grouped by intermediary person the number of groups to return and the size of the groups can be controlled by the desireduniquepersoncount and maxusersperperson arguments respectively mypathstoorganization docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect the current user to a given organization, ordered by the overall strength of the path mytoppathstoorganization docid 6wsl7ojzng jza bejcmf returns a collection of paths that connect the current user to a given organization, with 1st degree paths grouped together and 2nd degree paths grouped by intermediary person the number of groups to return and the size of the groups can be controlled by the desireduniquepersoncount and maxusersperperson arguments respectively getoverlapdetails docid 6wsl7ojzng jza bejcmf returns the shared employment history of two people that defines the overlap relationships between them personnetwork docid 6wsl7ojzng jza bejcmf returns a paginated set of overlap relationships that a given person has to other people personpathstoperson docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect one person to another, ordered by the overall strength of the path personpathstoorganization docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect a person to an organization, ordered by the overall strength of the path organizationpathstoorganization docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect one organization to another, ordered by the overall strength of the path personpathstopersonlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect a person to a person list, ordered by the overall strength of the path organizationpathstopersonlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect an organization to a person list, ordered by the overall strength of the path mypathstopersonlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect the user to a person list, ordered by the overall strength of the path mypathstoorganizationlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect the user to an organization list, ordered by the overall strength of the path personlistpathstopersonlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect one person list to another, ordered by the overall strength of the path personpathstoorganizationlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect a person to a organization list, ordered by the overall strength of the path organizationpathstoorganizationlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect an organization to a organization list, ordered by the overall strength of the path personlistpathstoorganizationlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect a person list to an organization list, ordered by the overall strength of the path organizationlistpathstoorganizationlist docid 6wsl7ojzng jza bejcmf returns a paginated collection of paths that connect one organization list to another, ordered by the overall strength of the path downloadpathfinderreport docid 6wsl7ojzng jza bejcmf n/a mycontacts docid 6wsl7ojzng jza bejcmf returns a collection of person ids that the current user has a has contact relationship with mycolleaguescontacts docid 6wsl7ojzng jza bejcmf returns a collection of person ids that are contacts of other users within the same account inforesponse fields name type description appversion string! the app version permissionsversion string! the version of the permissions configuration environment string! the app environment healthy boolean! returns the status of the service and the dependencies correlationid string! returns the correlation id for the request mypathstopersonresponse fields name type description start me! the current user, from who the paths in this response originate paths \[usertopersonpath!]! a collection of paths from the start user to the target person will be of type firstdegreeusertopersonpath if the user or their colleagues have added the person as a contact, seconddegreeusertopersonpath if a person the target has an overlap relationship with has been added by the user or their colleague as a contact target person! the person that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results me description represents the current authenticated user fields name type description id string! unique identifier firstname string first name lastname string last name role string role of the user accountname string account name email string email address user description interface for user entities (me and colleague) possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf fields name type description id string! unique identifier firstname string first name lastname string last name role string role of the user accountname string account name email string email address entity description base interface for entities in the relationships graph possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf fields name type description id string! unique identifier usertopersonpath description union type representing different path types from a user to a person possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf firstdegreenetworktopersonpath description represents a first degree path from a network to a person through innetwork relationship fields name type description entity1 network! the network entity in the path relationship1 innetwork! the innetwork relationship network description represents a network that users belong to fields name type description id string! unique identifier for the network name string! name of the network networktype networktype! type of network networktype description types of networks available in the system values value description derived company network n/a innetwork description represents an innetwork relationship indicating membership in a network fields name type description score float! deprecated numeric score for relationship strength relationshipstrength relationshipstrengthenum! the relative strength of the relationship relationshipstrengthenum description relative strength levels for relationships values value description weak n/a medium n/a strong n/a relationship description base interface for relationship types in the graph possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf fields name type description score float! deprecated numeric score for relationship strength relationshipstrength relationshipstrengthenum! the relative strength of the relationship firstdegreeusertopersonpath description represents a first degree path from a user to a person through contact relationship fields name type description entity1 user! the user entity in the path relationship1 contact! the contact relationship contact description represents a contact relationship between a user and a person fields name type description score float! deprecated numeric score for relationship strength contactrelationshipstype string type of contact relationship relationshipstrength relationshipstrengthenum! the relative strength of the relationship seconddegreenetworktopersonpath description represents a second degree path from a network to a person through innetwork and overlap relationships fields name type description entity1 network! the network entity in the path relationship1 innetwork! the innetwork relationship entity2 person! the intermediate person entity relationship2 overlap! the overlap relationship to the target person description represents a person entity in the relationships graph fields name type description id string! unique identifier for the person name string! full name of the person roleprimarytitle string primary role or job title roleprimaryorganization organization primary organization the person works for email string email address isrestricted boolean! indicates if the person information is restricted organization description represents an organization entity in the relationships graph fields name type description id string! unique identifier for the organization name string! name of the organization isrestricted boolean! indicates if the organization information is restricted overlap description represents an overlap relationship indicating shared employment history between two people fields name type description score float! deprecated numeric score for relationship strength overlaptypes \[overlaptype!]! types of overlap (e g , role) relationshipstrength relationshipstrengthenum! the relative strength of the relationship additionalinfo string additional information about the overlap overlaptype description types of overlap between people values value description role n/a family n/a seconddegreeusertopersonpath description represents a second degree path from a user to a person through contact and overlap relationships fields name type description entity1 user! the user entity in the path relationship1 contact! the contact relationship entity2 person! the intermediate person entity relationship2 overlap! the overlap relationship to the target pageinforesponse description total set of results in a paged query fields name type description totalcount int identifies the total count of items in the results pageinfo pageinfooutput! information about pagination in a paged set of results pageinfooutput fields name type description endcursor int when paginating forward, the index to continue from genericerror fields name type description errorcode string! a code referencing the type of error returned correlationid string! an id used to correlate logs and metrics across altrata services and processes errormessage string! the error message relating to the error returned genericerrorcode genericerrorcode! displays the generic error code genericerrorcode values value description internal error n/a error possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf fields name type description errorcode string! a code referencing the type of error returned correlationid string! an id used to correlate logs and metrics across altrata services and processes errormessage string! the error message relating to the error returned usernotfounderror fields name type description errorcode string! a code referencing the type of error returned usernotfounderrorcode usernotfounderrorcode! a code referencing the user not found error returned correlationid string! an id used to correlate logs and metrics across altrata services and processes errormessage string! the error message relating to the error returned usernotfounderrorcode values value description user not found n/a targetnotfounderror fields name type description errorcode string! a code referencing the type of error returned targetnotfounderrorcode targetnotfounderrorcode! a code referencing the target not found error returned correlationid string! an id used to correlate logs and metrics across altrata services and processes errormessage string! the error message relating to the error returned targetnotfounderrorcode values value description person not found n/a organization not found n/a person list not found n/a organization list not found n/a authorizationerror fields name type description errorcode string! a code referencing the type of error returned correlationid string! an id used to correlate logs and metrics across altrata services and processes errormessage string! the error message relating to the error returned authorizationerrorcode authorizationerrorcode! displays the error code authorizationerrorcode values value description feature n/a userrelationshiptypeenum description types of relationships a user can have values value description colleague n/a contact n/a mypathstopersonfilterinput mytoppathstopersonresponse fields name type description start me! the current user, from who the paths in this response originate paths \[usertopersonpath!]! a collection of paths from the start user to the target person will be of type firstdegreeusertopersonpath if the user or their colleagues have added the person as a contact, seconddegreeusertopersonpath if a person the target has an overlap relationship with has been added by the user or their colleague as a contact target person! the person that the paths in this response go to mypathstoorganizationresponse fields name type description start me! the current user, from who the paths in this response originate paths \[usertoorganizationpath!]! a collection of paths from the start user to the target organization will be of type firstdegreeusertoorganizationpath if the user or their colleagues have added a person who works at the organization as a contact, seconddegreeusertopersonpath if a person who works at the target organization has an overlap relationship with a person who has been added by the user or their colleague as a contact target organization! the organization that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results usertoorganizationpath description union type representing different path types from a user to an organization possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf firstdegreenetworktoorganizationpath description represents a first degree path from a network to an organization through innetwork and worksat relationships fields name type description entity1 network! the network entity in the path relationship1 innetwork! the innetwork relationship entity2 person! the intermediate person entity relationship2 worksat! the worksat relationship to the organization worksat description represents a worksat relationship between a person and an organization fields name type description score float! deprecated numeric score for relationship strength roletitle string job title or role at the organization email string email address at the organization relationshipstrength relationshipstrengthenum! the relative strength of the relationship firstdegreeusertoorganizationpath description represents a first degree path from a user to an organization through contact and worksat relationships fields name type description entity1 user! the user entity in the path relationship1 contact! the contact relationship entity2 person! the intermediate person entity relationship2 worksat! the worksat relationship to the organization seconddegreenetworktoorganizationpath description represents a second degree path from a network to an organization through innetwork, overlap, and worksat relationships fields name type description entity1 network! the network entity in the path relationship1 innetwork! the innetwork relationship entity2 person! the first intermediate person entity relationship2 overlap! the overlap relationship entity3 person! the second intermediate person entity relationship3 worksat! the worksat relationship to the organization seconddegreeusertoorganizationpath description represents a second degree path from a user to an organization through contact, overlap, and worksat relationships fields name type description entity1 user! the user entity in the path relationship1 contact! the contact relationship entity2 person! the first intermediate person entity relationship2 overlap! the overlap relationship entity3 person! the second intermediate person entity relationship3 worksat! the worksat relationship to the organization mypathstoorganizationfilterinput mytoppathstoorganizationresponse fields name type description start me! the current user, from who the paths in this response originate paths \[usertoorganizationpath!]! a collection of paths from the start user to the target organization will be of type firstdegreeusertoorganizationpath if the user or their colleagues have added a person who works at the organization as a contact, seconddegreeusertopersonpath if a person who works at the target organization has an overlap relationship with a person who has been added by the user or their colleague as a contact target organization! the organization that the paths in this response go to overlapdetailsresponse description response containing detailed overlap information between people fields name type description overlapdetails \[overlapwithdetails!]! collection of overlap details that were successfully found missingoverlaps \[missingoverlaps!]! collection of person pairs where overlap details could not be found overlapwithdetails description detailed information about an overlap between two people fields name type description person1 person! the first person person2 person! the second person overlap overlap! the overlap relationship between the two people detailsbyorganization \[organizationoverlapdetails!]! breakdown of overlap details by organization (for role overlaps) familydetails \[familyoverlapdetails!]! details of the family relationship (for family overlaps) organizationoverlapdetails description overlap details for a specific organization fields name type description organization organization! the organization where the overlap occurred duration duration! total duration of the overlap at this organization details \[overlapdetails!]! detailed breakdown of the overlap periods duration description represents a duration of time fields name type description length int! numeric length of the duration unit durationunit! unit of time for the duration isapproximate boolean! indicates if the duration is approximate durationunit description units of time for durations and date precision values value description day n/a month n/a year n/a overlapdetails description specific details about an overlap period fields name type description person1roletitle string role title of the first person during the overlap person2roletitle string role title of the second person during the overlap startdate dateinformation start date of the overlap period enddate dateinformation end date of the overlap period status string current status of the overlap dateinformation description represents date information with precision details fields name type description date string! iso formatted date string dateprecision durationunit! precision level of the date displaydate string! human readable display format of the date familyoverlapdetails description details about a family relationship overlap fields name type description person1relationshiptype string! the type of family relationship from person1's perspective (e g , "spouse", "parent", "child", "sibling") person2relationshiptype string! the type of family relationship from person2's perspective (e g , "spouse", "parent", "child", "sibling") missingoverlaps description represents a person pair where overlap details could not be found fields name type description personid1 string! the altrata id of the first person personid2 string! the altrata id of the second person overlapdetailsinput description input type for requesting overlap details between two people personnetworkresponse fields name type description start person! the person whose network you are querying paths \[personpath!]! a collection of paths to people that the start person has an overlap relationship with will be of type firstdegreepersontopersonpath pageinforesponse pageinforesponse! information about pagination in a paged set of results personpath possible types docid 6wsl7ojzng jza bejcmf firstdegreepersontopersonpath fields name type description relationship1 overlap! n/a entity1 person! n/a sourcenotfounderror fields name type description errorcode string! a code referencing the type of error returned sourcenotfounderrorcode sourcenotfounderrorcode! a code referencing the source not found error returned correlationid string! an id used to correlate logs and metrics across altrata services and processes errormessage string! the error message relating to the error returned sourcenotfounderrorcode values value description person not found n/a organization not found n/a person list not found n/a organization list not found n/a personpathstopersonresponse fields name type description start person! the person from who the paths in this response originate paths \[persontopersonpath!]! a collection of paths from the start person to the target person target person! the person that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results persontopersonpath description union type representing different path types from a person to another person possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf seconddegreepersontopersonpath description firstdegreepersontopersonpath is already defined above represents a second degree path from a person to another person through overlap relationships fields name type description relationship1 overlap! the first overlap relationship entity1 person! the intermediate person entity relationship2 overlap! the second overlap relationship to the target personpathstopersonfilterinput personpathstoorganizationresponse fields name type description start person! the person from who the paths in this response originate paths \[persontoorganizationpath!]! a collection of paths from the start person to the target organization target organization! the organization that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results persontoorganizationpath possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directpersontoorganizationpath description represents a direct path from a person to an organization through worksat relationship fields name type description relationship1 worksat! the worksat relationship firstdegreepersontoorganizationpath description represents a first degree path from a person to an organization through overlap and worksat relationships fields name type description relationship1 overlap! the overlap relationship entity1 person! the intermediate person entity relationship2 worksat! the worksat relationship to the organization seconddegreepersontoorganizationpath description represents a second degree path from a person to an organization through overlap and worksat relationships fields name type description relationship1 overlap! the first overlap relationship entity1 person! the first intermediate person entity relationship2 overlap! the second overlap relationship entity2 person! the second intermediate person entity relationship3 worksat! the worksat relationship to the organization personpathstoorganizationfilterinput organizationpathstoorganizationresponse fields name type description start organization! the organization from who the paths in this response originate paths \[organizationtoorganizationpath!]! a collection of paths from the start organization to the target organization target organization! the organization that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results organizationtoorganizationpath possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directorganizationtoorganizationpath description represents a direct path from an organization to another organization through a shared person fields name type description relationship1 worksat! the worksat relationship from the source organization entity1 person! the person entity that connects both organizations relationship2 worksat! the worksat relationship to the target organization firstdegreeorganizationtoorganizationpath description represents a first degree path from an organization to another organization through worksat and overlap relationships fields name type description relationship1 worksat! the worksat relationship from the source organization entity1 person! the first person entity relationship2 overlap! the overlap relationship between people entity2 person! the second person entity relationship3 worksat! the worksat relationship to the target organization seconddegreeorganizationtoorganizationpath description represents a second degree path from an organization to another organization through worksat and overlap relationships fields name type description relationship1 worksat! the worksat relationship from the source organization entity1 person! the first person entity relationship2 overlap! the first overlap relationship entity2 person! the second person entity relationship3 overlap! the second overlap relationship entity3 person! the third person entity relationship4 worksat! the worksat relationship to the target organization organizationpathstoorganizationfilterinput personpathstopersonlistresponse fields name type description start person! the person from who the paths in this response originate paths \[persontopersonlistpath!]! a collection of paths from the start person to the target person list target personlist! the person list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results persontopersonlistpath description union type representing different path types from a person to a person list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directpersontopersonlistpath description represents a direct path from a person to a person list through inlist relationship fields name type description relationship1 inlist! the inlist relationship inlist description represents an inlist relationship indicating an entity belongs to a specific list fields name type description score float! deprecated numeric score for relationship strength relationshipstrength relationshipstrengthenum! the relative strength of the relationship firstdegreepersontopersonlistpath description represents a first degree path from a person to a person list through overlap and inlist relationships fields name type description relationship1 overlap! the overlap relationship entity1 person! the person in the list relationship2 inlist! the inlist relationship to the person list seconddegreepersontopersonlistpath description represents a second degree path from a person to a person list through two overlap relationships and an inlist relationship fields name type description relationship1 overlap! the first overlap relationship entity1 person! the intermediate person entity relationship2 overlap! the second overlap relationship entity2 person! the person in the list relationship3 inlist! the inlist relationship to the person list personlist description represents a list of persons fields name type description listid string! id of the list listname string! name of the list entitylist possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf fields name type description listid string! id of the list listname string! name of the list personpathstopersonlistfilterinput organizationpathstopersonlistresponse fields name type description start organization! the organization from who the paths in this response originate paths \[organizationtopersonlistpath!]! a collection of paths from the start organization to the target person list target personlist! the person list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results organizationtopersonlistpath description union type representing different path types from an organization to a person list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directorganizationtopersonlistpath description represents a direct path from an organization to a person list through worksat and inlist relationships fields name type description relationship1 worksat! the worksat relationship from the organization entity1 person! the person in the list relationship2 inlist! the inlist relationship to the person list firstdegreeorganizationtopersonlistpath description represents a first degree path from an organization to a person list through worksat, overlap, and inlist relationships fields name type description relationship1 worksat! the worksat relationship from the organization entity1 person! the intermediate person entity relationship2 overlap! the overlap relationship between people entity2 person! the person in the list relationship3 inlist! the inlist relationship to the person list organizationpathstopersonlistfilterinput mypathstopersonlistresponse fields name type description start me! the user, from who the paths in this response originate paths \[usertopersonlistpath!]! a collection of paths from the start user to the target person list target personlist! the person list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results usertopersonlistpath description union type representing different path types from a user to a person list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf firstdegreeusertopersonlistpath description represents a first degree path from a user to a person list through contact and inlist relationships fields name type description entity1 user! the user entity in the path relationship1 contact! the contact relationship entity2 person! the intermediate person entity relationship2 inlist! the inlist relationship to the person list seconddegreeusertopersonlistpath description represents a second degree path from a user to a person list through contact, overlap, and inlist relationships fields name type description entity1 user! the user entity in the path relationship1 contact! the contact relationship entity2 person! the first intermediate person entity relationship2 overlap! the overlap relationship entity3 person! the second intermediate person entity relationship3 inlist! the inlist relationship to the person list firstdegreenetworktopersonlistpath description represents a first degree path from a network to a personlist through innetwork relationship fields name type description entity1 network! the network entity in the path relationship1 innetwork! the innetwork relationship entity2 person! the intermediate person entity relationship2 inlist! the inlist relationship to the person list seconddegreenetworktopersonlistpath description represents a second degree path from a network to a personlist through innetwork, overlap and inlist relationship fields name type description entity1 network! the network entity in the path relationship1 innetwork! the innetwork relationship entity2 person! the first intermediate person entity relationship2 overlap! the overlap relationship entity3 person! the second intermediate person entity relationship3 inlist! the inlist relationship to the person list mypathstopersonlistfilterinput mypathstoorganizationlistresponse fields name type description start me! the user, from who the paths in this response originate paths \[usertoorganizationlistpath!]! a collection of paths from the start user to the target organization list target organizationlist! the organization list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results usertoorganizationlistpath description union type representing different path types from a user to an organization list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf firstdegreeusertoorganizationlistpath description represents a first degree path from a user to an organization list through contact, worksat, and inlist relationships fields name type description entity1 user! the user entity in the path relationship1 contact! the contact relationship entity2 person! the intermediate person entity relationship2 worksat! the worksat relationship to the organization in the target list entity3 organization! the organization in the target list relationship3 inlist! the inlist relationship to the organization list firstdegreenetworktoorganizationlistpath description represents a first degree path from a network to an organization list through innetwork, worksat, and inlist relationships fields name type description entity1 network! the network entity in the path relationship1 innetwork! the innetwork relationship entity2 person! the intermediate person entity relationship2 worksat! the worksat relationship to the organization in the target list entity3 organization! the organization in the target list relationship3 inlist! the inlist relationship to the organization list organizationlist description represents a list of organizations fields name type description listid string! id of the list listname string! name of the list mypathstoorganizationlistfilterinput personlistpathstopersonlistresponse fields name type description start personlist! the person list from who the paths in this response originate paths \[personlisttopersonlistpath!]! a collection of paths from the start person list to the target person list target personlist! the person list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results personlisttopersonlistpath description union type representing different path types from a person list to another person list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directpersonlisttopersonlistpath description represents a direct path from a person list to another person list through inlist relationships fields name type description relationship1 inlist! the inlist relationship from the source person list entity1 person! the person entity that connects both person lists relationship2 inlist! the inlist relationship to the target person list firstdegreepersonlisttopersonlistpath description represents a first degree path from a person list to another person list through inlist, overlap, and inlist relationships fields name type description relationship1 inlist! the inlist relationship from the source person list entity1 person! the first person entity relationship2 overlap! the overlap relationship between people entity2 person! the second person entity relationship3 inlist! the inlist relationship to the target person list personlistpathstopersonlistfilterinput personpathstoorganizationlistresponse fields name type description start person! the person from who the paths in this response originate paths \[persontoorganizationlistpath!]! a collection of paths from the start person to the target organization list target organizationlist! the organization list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results persontoorganizationlistpath description union type representing different path types from a person to an organization list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directpersontoorganizationlistpath description represents a direct path from a person to an organization list fields name type description relationship1 worksat! the worksat relationship from the source person to the organization in the target list entity1 organization! the organization in the target list relationship2 inlist! the inlist relationship to the organization list firstdegreepersontoorganizationlistpath description represents a first degree path from a person to an organization list fields name type description relationship1 overlap! the overlap relationship from the source person entity1 person! the intermediate person entity relationship2 worksat! the worksat relationship to the organization in the target list entity2 organization! the organization in the target list relationship3 inlist! the inlist relationship to the organization list personpathstoorganizationlistfilterinput organizationpathstoorganizationlistresponse fields name type description start organization! the organization from who the paths in this response originate paths \[organizationtoorganizationlistpath!]! a collection of paths from the start organization to the target organization list target organizationlist! the organization list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results organizationtoorganizationlistpath description union type representing different path types from an organization to an organization list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directorganizationtoorganizationlistpath description represents a direct path from an organization to an organization list fields name type description relationship1 worksat! the worksat relationship from the source organization entity1 person! the person who works at an organization in the target list relationship2 worksat! the worksat relationship to the organization in the target list entity2 organization! the organization in the target list relationship3 inlist! the inlist relationship to the organization list firstdegreeorganizationtoorganizationlistpath description represents a first degree path from an organization to an organization list fields name type description relationship1 worksat! the worksat relationship from the source organization entity1 person! the person who works at the source organization relationship2 overlap! the overlap relationship between people entity2 person! the person who works at an organization in the target list relationship3 worksat! the worksat relationship to the organization in the target list entity3 organization! the organization in the target list relationship4 inlist! the inlist relationship to the organization list organizationpathstoorganizationlistfilterinput personlistpathstoorganizationlistresponse fields name type description start personlist! the person list from who the paths in this response originate paths \[personlisttoorganizationlistpath!]! a collection of paths from the start person list to the target organization list target organizationlist! the organization list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results personlisttoorganizationlistpath description union type representing different path types from a person list to an organization list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directpersonlisttoorganizationlistpath description represents a direct path from a person list to an organization list fields name type description relationship1 inlist! the inlist relationship from the source person list entity1 person! the person in the source person list relationship2 worksat! the worksat relationship to the organization in the target list entity2 organization! the organization in the target list relationship3 inlist! the inlist relationship to the organization list firstdegreepersonlisttoorganizationlistpath description represents a first degree path from a person list to an organization list fields name type description relationship1 inlist! the inlist relationship from the source person list entity1 person! the person in the source person list relationship2 overlap! the overlap relationship between people entity2 person! the person who works at an organization in the target list relationship3 worksat! the worksat relationship to the organization in the target list entity3 organization! the organization in the target list relationship4 inlist! the inlist relationship to the organization list personlistpathstoorganizationlistfilterinput organizationlistpathstoorganizationlistresponse fields name type description start organizationlist! the organization list from who the paths in this response originate paths \[organizationlisttoorganizationlistpath!]! a collection of paths from the start organization list to the target organization list target organizationlist! the organization list that the paths in this response go to pageinforesponse pageinforesponse! information about pagination in a paged set of results organizationlisttoorganizationlistpath description union type representing different path types from an organization list to another organization list possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf directorganizationlisttoorganizationlistpath description represents a direct path from an organization list to another organization list fields name type description relationship1 inlist! the inlist relationship from the source organization list entity1 organization! the organization in the source list relationship2 worksat! the worksat relationship from the organization in the source list entity2 person! the person who works at organizations in both lists relationship3 worksat! the worksat relationship to the organization in the target list entity3 organization! the organization in the target list relationship4 inlist! the inlist relationship to the target organization list firstdegreeorganizationlisttoorganizationlistpath description represents a first degree path from an organization list to another organization list fields name type description relationship1 inlist! the inlist relationship from the source organization list entity1 organization! the organization in the source list relationship2 worksat! the worksat relationship from the organization in the source list entity2 person! the person who works at the organization in the source list relationship3 overlap! the overlap relationship between people entity3 person! the person who works at an organization in the target list relationship4 worksat! the worksat relationship to the organization in the target list entity4 organization! the organization in the target list relationship5 inlist! the inlist relationship to the target organization list organizationlistpathstoorganizationlistfilterinput downloadpathfinderreportresult possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf downloadpathfinderreportresponse fields name type description downloadurl string! the signed url to download the generated report pathfinderreporttemplate values value description person to person n/a person to organization n/a organization to person n/a organization to organization n/a person to person list n/a organization to person list n/a person list to person list n/a person to organization list n/a organization to organization list n/a person list to organization list n/a organization list to organization list n/a organization list to person list n/a person list to person n/a person list to organization n/a organization list to person n/a organization list to organization n/a mycontactsresult possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf mycontactsresponse fields name type description contactids \[string!]! a collection of person ids that the current user has a has contact relationship with mycolleaguescontactsresult possible types docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf docid 6wsl7ojzng jza bejcmf mycolleaguescontactsresponse fields name type description colleaguescontactsids \[string!]! a collection of person ids that are contacts of other users within the same account colleague description represents a colleague of the current user in the same network fields name type description id string! unique identifier firstname string first name lastname string last name role string role of the colleague accountname string account name email string email address