Relationships API

Query

Fields:

Name	Returns	Description
info	InfoResponseInfoResponse	N/A
myPathsToPerson	MyPathsToPersonResponseMyPathsToPersonResponse	Returns a paginated collection of paths that connect the current User to a given Person, ordered by the overall strength of the path
myTopPathsToPerson	MyTopPathsToPersonResponseMyTopPathsToPersonResponse	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	MyPathsToOrganizationResponseMyPathsToOrganizationResponse	Returns a paginated collection of paths that connect the current User to a given Organization, ordered by the overall strength of the path
myTopPathsToOrganization	MyTopPathsToOrganizationResponseMyTopPathsToOrganizationResponse	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	OverlapDetailsResponseOverlapDetailsResponse	Returns the shared employment history of two People that defines the Overlap relationships between them
personNetwork	PersonNetworkResponsePersonNetworkResponse	Returns a paginated set of Overlap relationships that a given Person has to other People
personPathsToPerson	PersonPathsToPersonResponsePersonPathsToPersonResponse	Returns a paginated collection of paths that connect one Person to another, ordered by the overall strength of the path
personPathsToOrganization	PersonPathsToOrganizationResponsePersonPathsToOrganizationResponse	Returns a paginated collection of paths that connect a Person to an Organization, ordered by the overall strength of the path
organizationPathsToOrganization	OrganizationPathsToOrganizationResponseOrganizationPathsToOrganizationResponse	Returns a paginated collection of paths that connect one Organization to another, ordered by the overall strength of the path
personPathsToPersonList	PersonPathsToPersonListResponsePersonPathsToPersonListResponse	Returns a paginated collection of paths that connect a Person to a Person List, ordered by the overall strength of the path
organizationPathsToPersonList	OrganizationPathsToPersonListResponseOrganizationPathsToPersonListResponse	Returns a paginated collection of paths that connect an Organization to a Person List, ordered by the overall strength of the path
myPathsToPersonList	MyPathsToPersonListResponseMyPathsToPersonListResponse	Returns a paginated collection of paths that connect the User to a Person List, ordered by the overall strength of the path
myPathsToOrganizationList	MyPathsToOrganizationListResponseMyPathsToOrganizationListResponse	Returns a paginated collection of paths that connect the User to an Organization List, ordered by the overall strength of the path
personListPathsToPersonList	PersonListPathsToPersonListResponsePersonListPathsToPersonListResponse	Returns a paginated collection of paths that connect one Person List to another, ordered by the overall strength of the path
personPathsToOrganizationList	PersonPathsToOrganizationListResponsePersonPathsToOrganizationListResponse	Returns a paginated collection of paths that connect a Person to a Organization List, ordered by the overall strength of the path
organizationPathsToOrganizationList	OrganizationPathsToOrganizationListResponseOrganizationPathsToOrganizationListResponse	Returns a paginated collection of paths that connect an Organization to a Organization List, ordered by the overall strength of the path
personListPathsToOrganizationList	PersonListPathsToOrganizationListResponsePersonListPathsToOrganizationListResponse	Returns a paginated collection of paths that connect a Person List to an Organization List, ordered by the overall strength of the path
organizationListPathsToOrganizationList	OrganizationListPathsToOrganizationListResponseOrganizationListPathsToOrganizationListResponse	Returns a paginated collection of paths that connect one Organization List to another, ordered by the overall strength of the path
downloadPathfinderReport	DownloadPathfinderReportResponseDownloadPathfinderReportResponse	N/A
myContacts	MyContactsResponseMyContactsResponse	Returns a collection of Person IDs that the current User has a has_contact relationship with
myColleaguesContacts	MyColleaguesContactsResponseMyColleaguesContactsResponse	Returns a collection of Person IDs that are contacts of other Users within the same Account
myNetwork	—	Returns a paginated collection of Person IDs in the current user's 1st degree network (contacts, colleague contacts, and derived network)
seniorLeadersToOrganizations	—	Returns leadership paths where the senior leaders (board members or leadership team) of the source organization hold positions.

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:

MeMe

ColleagueColleague

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:

MeMe

NetworkNetwork

PersonPerson

OrganizationOrganization

ColleagueColleague

Fields:

Name	Type	Description
id	String!	Unique identifier

UserToPersonPath

Description: Union type representing different path types from a User to a Person

Possible Types:

FirstDegreeNetworkToPersonPathFirstDegreeNetworkToPersonPath

FirstDegreeUserToPersonPathFirstDegreeUserToPersonPath

SecondDegreeNetworkToPersonPathSecondDegreeNetworkToPersonPath

SecondDegreeUserToPersonPathSecondDegreeUserToPersonPath

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:

InNetworkInNetwork

ContactContact

OverlapOverlap

WorksAtWorksAt

InListInList

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:

GenericErrorGenericError

UserNotFoundErrorUserNotFoundError

TargetNotFoundErrorTargetNotFoundError

AuthorizationErrorAuthorizationError

SourceNotFoundErrorSourceNotFoundError

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:

FirstDegreeNetworkToOrganizationPathFirstDegreeNetworkToOrganizationPath

FirstDegreeUserToOrganizationPathFirstDegreeUserToOrganizationPath

SecondDegreeNetworkToOrganizationPathSecondDegreeNetworkToOrganizationPath

SecondDegreeUserToOrganizationPathSecondDegreeUserToOrganizationPath

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:

FirstDegreePersonToPersonPathFirstDegreePersonToPersonPath

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:

FirstDegreePersonToPersonPathFirstDegreePersonToPersonPath

SecondDegreePersonToPersonPathSecondDegreePersonToPersonPath

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:

DirectPersonToOrganizationPathDirectPersonToOrganizationPath

FirstDegreePersonToOrganizationPathFirstDegreePersonToOrganizationPath

SecondDegreePersonToOrganizationPathSecondDegreePersonToOrganizationPath

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:

DirectOrganizationToOrganizationPathDirectOrganizationToOrganizationPath

FirstDegreeOrganizationToOrganizationPathFirstDegreeOrganizationToOrganizationPath

SecondDegreeOrganizationToOrganizationPathSecondDegreeOrganizationToOrganizationPath

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:

DirectPersonToPersonListPathDirectPersonToPersonListPath

FirstDegreePersonToPersonListPathFirstDegreePersonToPersonListPath

SecondDegreePersonToPersonListPathSecondDegreePersonToPersonListPath

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:

PersonListPersonList

OrganizationListOrganizationList

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:

DirectOrganizationToPersonListPathDirectOrganizationToPersonListPath

FirstDegreeOrganizationToPersonListPathFirstDegreeOrganizationToPersonListPath

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:

FirstDegreeUserToPersonListPathFirstDegreeUserToPersonListPath

SecondDegreeUserToPersonListPathSecondDegreeUserToPersonListPath

FirstDegreeNetworkToPersonListPathFirstDegreeNetworkToPersonListPath

SecondDegreeNetworkToPersonListPathSecondDegreeNetworkToPersonListPath

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:

FirstDegreeUserToOrganizationListPathFirstDegreeUserToOrganizationListPath

SecondDegreeUserToOrganizationListPathSecondDegreeUserToOrganizationListPath

FirstDegreeNetworkToOrganizationListPathFirstDegreeNetworkToOrganizationListPath

SecondDegreeNetworkToOrganizationListPathSecondDegreeNetworkToOrganizationListPath

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

SecondDegreeUserToOrganizationListPath

Description: Represents a second-degree path from a User to an Organization List through Contact, Overlap, WorksAt, 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 (the contact)
relationship2	Overlap!	The Overlap relationship
entity3	Person!	The second intermediate Person entity (the overlap)
relationship3	WorksAt!	The WorksAt relationship to the Organization in the target List
entity4	Organization!	The Organization in the target List
relationship4	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

SecondDegreeNetworkToOrganizationListPath

Description: Represents a second-degree path from a Network to an Organization List through InNetwork, Overlap, WorksAt, and InList 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 (the alumnus connected to the network)
relationship2	Overlap!	The Overlap relationship
entity3	Person!	The second intermediate Person entity (the overlap who works at the target Organization)
relationship3	WorksAt!	The WorksAt relationship to the Organization in the target List
entity4	Organization!	The Organization in the target List
relationship4	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:

DirectPersonListToPersonListPathDirectPersonListToPersonListPath

FirstDegreePersonListToPersonListPathFirstDegreePersonListToPersonListPath

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:

DirectPersonToOrganizationListPathDirectPersonToOrganizationListPath

FirstDegreePersonToOrganizationListPathFirstDegreePersonToOrganizationListPath

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:

DirectOrganizationToOrganizationListPathDirectOrganizationToOrganizationListPath

FirstDegreeOrganizationToOrganizationListPathFirstDegreeOrganizationToOrganizationListPath

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:

DirectPersonListToOrganizationListPathDirectPersonListToOrganizationListPath

FirstDegreePersonListToOrganizationListPathFirstDegreePersonListToOrganizationListPath

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:

DirectOrganizationListToOrganizationListPathDirectOrganizationListToOrganizationListPath

FirstDegreeOrganizationListToOrganizationListPathFirstDegreeOrganizationListToOrganizationListPath

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:

DownloadPathfinderReportResponseDownloadPathfinderReportResponse

GenericErrorGenericError

SourceNotFoundErrorSourceNotFoundError

TargetNotFoundErrorTargetNotFoundError

AuthorizationErrorAuthorizationError

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
MY_NETWORK_TO_PERSON	N/A
MY_NETWORK_TO_ORGANIZATION	N/A
MY_NETWORK_TO_PERSON_LIST	N/A
MY_NETWORK_TO_ORGANIZATION_LIST	N/A

PathfinderReportFormat

Values:

Value	Description
PDF	N/A
CSV	N/A

MyContactsResult

Possible Types:

MyContactsResponseMyContactsResponse

GenericErrorGenericError

UserNotFoundErrorUserNotFoundError

AuthorizationErrorAuthorizationError

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:

MyColleaguesContactsResponseMyColleaguesContactsResponse

GenericErrorGenericError

UserNotFoundErrorUserNotFoundError

AuthorizationErrorAuthorizationError

MyColleaguesContactsResponse

Fields:

Name	Type	Description
colleaguesContactsIds	[String!]!	A collection of Person IDs that are contacts of other Users within the same Account
colleaguesContacts	[UserContact!]	A collection of contacts belonging to colleagues within the same Account

UserContact

Fields:

Name	Type	Description
person	Person!	The Person who is the contact
user	User!	The User (Me or Colleague) who has this contact
contact	Contact!	The Contact relationship between the User and the Person

MyNetworkResult

Possible Types:

MyNetworkResponseMyNetworkResponse

GenericErrorGenericError

UserNotFoundErrorUserNotFoundError

AuthorizationErrorAuthorizationError

MyNetworkResponse

Fields:

Name	Type	Description
networkPersonIds	[String!]!	A collection of Person IDs in the current user's 1st degree network
pageInfoResponse	PageInfoResponse!	Information about pagination in a paged set of results

SeniorLeadersToOrganizationsResult

Description: Union type representing the result of a senior leaders to organizations query

Possible Types:

SeniorLeadersToOrganizationsResponseSeniorLeadersToOrganizationsResponse

GenericErrorGenericError

SourceNotFoundErrorSourceNotFoundError

AuthorizationErrorAuthorizationError

SeniorLeadersToOrganizationsResponse

Description: Response containing organizations connected through senior leaders of a source organization

Fields:

Name	Type	Description
sourceOrganization	Organization!	The source organization
paths	[SeniorLeadershipPath!]!	The paths connecting the source organization to other organizations via shared senior leaders

SeniorLeadershipPath

Description: Represents a path connecting organizations through a shared senior leader

Fields:

Name	Type	Description
leadership	SeniorLeaderOfOrganization!	The senior leader's role at the source organization
otherLeaderships	[SeniorLeaderOfOrganization!]!	The senior leader's roles at other organizations

SeniorLeaderOfOrganization

Description: Represents a person's senior leadership position at a specific organization

Fields:

Name	Type	Description
person	Person!	The person holding the senior leadership role
relationship	SeniorLeaderOf!	The senior leadership relationship details
organization	Organization!	The organization where the person holds the leadership role

SeniorLeaderOf

Description: Represents a relationship between a Leader and an Organization

Fields:

Name	Type	Description
roleId	String!	The id of the leadership role
roleTitle	String!	The title of the leadership role
seniority	Seniority!	The seniority classification of the role

Seniority

Description: Represents the sonority of relationship

Values:

Value	Description
LEADERSHIP_TEAM	N/A
BOARD	N/A

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