# List Relations

Read a page of relations from a Business Partner Storage.

Endpoint: GET /v4/storages/{storageId}/relations
Version: 5
Security: apiKey

## Path parameters:

  - `storageId` (string, required)
    Unique identifier of the Storage.
    Example: "72d6900fce6b326088f5d9d91049e3e6"

## Query parameters:

  - `startAfter` (string)
    Only items with an ID greater than the given one will be retrieved.

When nextStartAfter provided in the response, should be used instead of the ID
as an indicator for a next page.
    Example: "5712566172571652"

  - `limit` (integer)
    Number of items to be returned on the page.
    Example: "100"

  - `featureOn` (array)
    Features to be activated during Relations read.
    Enum: "SHOW_BUSINESS_PARTNER_INFORMATION"

  - `featureOff` (array)
    Features to be deactivated during Relations read.
    Enum: "SHOW_BUSINESS_PARTNER_INFORMATION"

  - `externalId` (string)
    Business Partner externalIDs.
    Example: "The ID managed in the customer's SAP systems."

  - `dataSource` (string)
    Data Source (name or ID) used to filter the result of Business Partner Relations returned.
    Example: "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""

  - `type` (string)
    Filter by type.
    Example: "COMMERCIAL_ULTIMATE"

  - `classTechnicalKey` (string)
    Filter by class technical key. List of available (classes)[https://meta.cdq.com/Business_partner/relation/class].
    Example: "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"

  - `endedAfter` (string)
    Find relations which endedAt is after given date.
    Example: "2025-09-10T10:12:35Z"

  - `endedBefore` (string)
    Find relations which endedAt is before given date.
    Example: "2025-09-10T10:12:35Z"

  - `startedAfter` (string)
    Find relations which startedAt is after given date.
    Example: "2025-09-10T10:12:35Z"

  - `startedBefore` (string)
    Find relations which startedAt is before given date
    Example: "2025-09-10T10:12:35Z"

  - `acting` (string)
    Find relations that are ACTIVE or INACTIVE.
    Enum: "ACTIVE", "INACTIVE"

## Response 200 fields (application/json):

  - `startAfter` (string)
    The ID which is used to read the page.
    Example: "5712566172571652"

  - `nextStartAfter` (string)
    Provides a value to be used as a startAfter in next page request.
    Example: "5712566172571652"

  - `limit` (integer)
    Number of items per page.
    Example: "100"

  - `total` (integer)
    Total number of items which can be paged.
    Example: "67"

  - `values` (array)
    List of relations between Business Partners.

  - `values.startedAt` (string)
    Describe when this relationship was first established.
    Example: "2025-09-10T10:12:36Z"

  - `values.endedAt` (string)
    Describe when this relationship ended.
    Example: "2025-09-10T10:12:36Z"

  - `values.type` (object)
    Provides information about the type of the relationship between two Business Partners like:\ direct parent/child, ultimate parent, branch.

  - `values.type.name` (string)
    Display name of the Business Partner Relation Type.
    Example: "Commercial ultimate"

  - `values.type.technicalKey` (string)
    Technical Key of the Business Partner Relation Type.
    Example: "COMMERCIAL_ULTIMATE"

  - `values.type.url` (string)
    URL to the documentation which summarizes all details of a [Business Partner Relation Type](https://meta.cdq.com/Business_partner/relation/type).
    Example: "https://meta.cdq.com/Business_partner/relation/type"

  - `values.class` (object)
    Provides information about the classification of the relation.

  - `values.class.name` (string)
    Display name of the Business Partner Relation Class.
    Example: "CDQ Hierarchy"

  - `values.class.technicalKey` (string)
    Technical Key of the Business Partner Relation Class.
    Example: "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"

  - `values.class.url` (string)
    URL to the documentation which summarizes all details of a [Business Partner Relation Class](https://meta.cdq.com/Business_partner/relation/class).
    Example: "https://meta.cdq.com/Business_partner/relation/class"

  - `values.startNode` (object)
    Unique identifiers for Business Partner in the relation

  - `values.startNode.externalId` (string)
    Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.
    Example: "The ID managed in the customer's SAP systems."

  - `values.startNode.dataSourceId` (string)
    Unique identifier for a Data Source of the Storage.
    Example: "648824a691d8d2503d65103e"

  - `values.endNode` (object)
    Unique identifiers for Business Partner in the relation

  - `values.deactivatedAt` (string)
    Describe when this relationship was deactivated. Read only.
    Example: "2025-09-10T10:12:36Z"