v1
latestOpenAPI 3.1.02026-07-22750642.5 KBCDP Relationships
List relationships
List relationship edges of one kind, anchored on a person or custom object, newest first.
get/api/v1/cdp/relationships
Query parameters
kind'person_to_co' | 'co_to_co' required
Which edge set to list.
personExternalIdstring
Anchor: person externalId (kind 'person_to_co').
customObjectTypestring
Anchor: custom object type name. Required with customObjectExternalId.
customObjectExternalIdstring
Anchor: custom object externalId (scoped by customObjectType).
direction'children' | 'parents'
For kind 'co_to_co': list the anchor's children (default) or parents.
include_removedboolean
Include soft-deleted (unlinked) edges. Defaults to false.
relationshipTypeIdstring
Filter by relationship type id.
rolestring
Filter by edge role.
limitinteger
Max items to return, 1-1000 (default 100).
cursorstring
Opaque pagination token from a previous response's next_cursor. Omit for the first page.
Response
Success