Sign in

v2

latestOpenAPI 3.1.02026-07-262653151.5 KB
network-mapper

Relationships

Find connected profiles with their connection details. Renamed from Network Mapper in v3.

post/v3/relationships

Headers

x-authenticate-teamstring

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.

Request body

queryobject required

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

limitinteger

Limit the number of results

pagination_tokenstring

Pagination token received in the previous response

Example request

{
  "query": {
    "match": {
      "profile_info.job_title": {
        "query": "Data Scientist"
      }
    }
  }
}

Response

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

countinteger required
total_countinteger required
pagination_tokenstring

Pagination token for the next request