Relationships
Endpoints (v3)
Relationships
Find connected profiles with their connection details. Renamed from Network Mapper in v3.
POST
Relationships
Relationships requests do not consume API credits. See Credits & Usage.
x-authenticate-team header — the response then reflects the connectors and connections of that child team’s network instead. See Partner teams below.
The request body accepts a standard OpenSearch DSL query plus optional limit and pagination_token top-level parameters.
For request and response examples, see Relationships endpoint examples.
For the response schema, see Models > Network Mapper.
Filtering by indexed fields
The OpenSearch DSLquery body lets you filter on any indexed field on the profile document. The most common patterns are:
- Filter by a specific team member (connector) — query the top-level
connected_usersfield (keyword) with atermclause. - Filter by how the connection was synced — query the nested
team_connections.originsfield (keyword) with anestedquery, typically scoped to yourteam_connections.team_id. - Filter by profile attributes — query any indexed profile field (title, company, location, seniority, etc.) the same way you would in Search Profiles.
Partner teams
Partners can execute a request in the context of a child team by passing the child team’s ID in thex-authenticate-team header:
- With the header — the query runs against the child team’s network (its connectors and their connections).
- Without the header — the query runs against the network of the team that owns the API key (default).
child_team_id is returned when you create a child team.
Example request
Authorizations
Headers
Partner accounts only. When present, the request is executed in the context of the specified child team (use the team_id returned by Create Team). When omitted, the request runs as the team that owns the API key.
Body
application/json
Search query in the ElasticSearch Query DSL format. Find mapping here
Example:
Limit the number of results
Required range:
0 <= x <= 1000Pagination token received in the previous response

