Skip to main content
POST
Relationships
Relationships requests do not consume API credits. See Credits & Usage.
By default, the Relationships endpoint returns profiles connected to the team that owns the API key, along with connection details. Responses are returned synchronously. Partners can scope the query to a specific child team by passing the child teamโ€™s ID in the 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 DSL query 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_users field (keyword) with a term clause.
  • Filter by how the connection was synced โ€” query the nested team_connections.origins field (keyword) with a nested query, typically scoped to your team_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.
See OpenSearch Profile Mappings (v3) for the full list of indexed fields, and Relationships endpoint examples for ready-to-use queries.

Partner teams

Partners can execute a request in the context of a child team by passing the child teamโ€™s ID in the x-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).
The child_team_id is returned when you create a child team.

Example request

Authorizations

x-api-key
string
header
required

Headers

x-authenticate-team
string

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
query
object
required

Search query in the ElasticSearch Query DSL format. Find mapping here

Example:
limit
integer
default:100

Limit the number of results

Required range: 0 <= x <= 1000
pagination_token
string

Pagination token received in the previous response

Response

list of found profiles that are connected to your team, and match your query

items
object[]
required
count
integer
required
total_count
integer
required
pagination_token
string

Pagination token for the next request