Skip to main content
POST
Bulk recommended relationship paths for up to 100 target persons.

Authorizations

x-api-key
string
header
required

Body

application/json
uuids
string[]
required
include_items
boolean
default:true

When false (companies only), skip the expensive items[] recommended-paths list and return just top_external_contacts per company. Resolved with batched queries, so large batches stay fast. Use this if you only consume top_external_contacts.

limit
integer
default:25

Max contacts returned per target (1-100).

order
enum<string>
default:desc

Sort order. Default: 'desc' (highest score first)

Available options:
asc,
desc
sort_by
enum<string> | null

Field to sort by. Valid values: 'score', 'name'

Available options:
score,
name

Response

200 - application/json

Bulk recommended-paths response.

results holds one RecommendedPathsResponse per input UUID, in the same order as the request. Targets that are not found come back with empty items rather than failing the whole batch.

results
RecommendedPathsResponse · object[]
required