# List Storages

List all storages to which user has access to.

Endpoint: GET /v2/storages
Version: 5
Security: apiKey

## 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"

  - `label` (string)
    Filter the result by the given label. Keep in mind that labels are case-sensitive.
    Example: "My Storage"

  - `includeSharedStorages` (boolean)
    Optionally extend the result with metadata for storages that have been shared by other users of your organization.
Alias for  feature.
    Example: "true"

  - `sort` (string)
    Defines the attributes to sort by. Supported attributes are 'id', 'name' and 'createdAt', separated by comma (,) and the
sort direction in front of each attribute. '+' means ascending, '-' means descending. Default sort, if direction is not given, is ascending.
    Example: "-createdAt"

  - `dataMapperDefinitionId` (array)
    Filter the result and Data Sources by Data Mapper Definition ID.
    Example: ["6440dba32b30176c5917b1b7"]

  - `featuresOn` (array)
    Features to be activated.
    Enum: "NUMBER_OF_TOTAL", "INCLUDE_SHARED_STORAGES", "INCLUDE_SHARED_WORKSPACE_STORAGES"

## Response 200 fields (application/json):

  - `values` (array)
    List of Business Partner Storages Metadata Page.

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

  - `values.name` (string)
    Name of the Business Partner Storage.
    Example: "CDQ AG"

  - `values.eventStoreId` (string)
    Internal ID of Event Store.
    Example: "72d6900fce6b326123f5d9d91049e3e6"

  - `values.decisionLogId` (string)
    ID of related decision log.
    Example: "72d6900fc3wb326088f5d9d91044e3e6"

  - `values.organization` (string)
    Uniquely identifying ID of the organization.
    Example: "cdq_monitor"

  - `values.user` (string)
    Unique ID of a user.
    Example: "johndoe"

  - `values.createdAt` (string)
    Date of creation (ISO 8601-compliant).
    Example: "2025-09-10T12:35:59Z"

  - `values.expiresAt` (string)
    Date when storage expires.

Possible values:
* a date when a storage expires,
* NEVER when storage is a Data Mirror or has been created including NEVER_EXPIRE feature.

Expiry date is calculated based on the date of last write operation related
to a storage (upsert of data, update of data sources, executed job) plus 6 months,
refreshed as most 2 weeks before previous storage expiration date.
    Example: "2025-09-10T12:35:58Z"

  - `values.dataMatchingDefinitionId` (string)
    ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage.
    Example: "6400955811c68a034bcef311"

  - `values.dataSources` (array)
    List of Data Sources.

  - `values.dataSources.lastUpdatedAt` (string)
    Date of modification (ISO 8601-compliant).
    Example: "2025-09-10T12:35:58Z"

  - `values.dataSources.name` (string)
    Name of a data source of a storage.
    Example: "Internal customers"

  - `values.dataSources.dataMapperDefinitionId` (string)
    ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.
    Example: "6440dba32b30176c5917b1b7"

  - `values.dataSources.dataTransformationDefinitionId` (string)
    Unique identifier for a data transformation definition.
    Example: "SAP.ODM"

  - `values.dataSources.mappingDisclosure` (boolean)
    Determines whether disclosed field is set via Data Mapper Definition (true) or via Sharing Scopes (false). For more details, you can
read about [Data Mapper Definition](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Mapping/paths/~1datamapperdefinitions/post/) and [Sharing Scopes](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partner-Storages/paths/~1v4~1storages~1%7BstorageId%7D~1sharingscopes/post/)."
    Example: "true"

  - `values.dataMonitors` (array)
    List of data monitors.

  - `values.dataMonitors.id` (string)
    Unique alpha-numeric number of the Data Monitor.
    Example: "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"

  - `values.dataMonitors.type` (object)
    Type of the Data Monitor.

  - `values.dataMonitors.type.name` (string)
    Display name of the Data Monitor Type.
    Example: "Augmentation"

  - `values.dataMonitors.type.technicalKey` (string)
    Technical key of a data monitor.
    Example: "AUGMENTATION"

  - `values.dataMonitors.enabled` (boolean)
    The toggle used to enable or disable the Data Monitor.
    Example: true

  - `values.dataMonitors.disabledAt` (string)
    Date in ISO-8601 format when data monitor was disabled.
    Example: "2025-09-10T12:35:58Z"

  - `values.dataMonitors.configuration` (object)
    Configuration which is used during processing Business Partners.

  - `values.dataMonitors.configuration.id` (string)
    Uniquely identifies a configuration.
    Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

  - `values.dataMonitors.executions` (array)
    Available executions of data monitor.

  - `values.dataMonitors.executions.type` (object, required)
    Type of the Data Monitor Execution.

  - `values.dataMonitors.executions.type.technicalKey` (string, required)
    Technical key of the Data Monitor Execution Type.
    Example: "TRIGGER"

  - `values.dataMonitors.executions.frequency` (string)
    It is the interval at which updates are performed.
    Example: "BI_WEEKLY"

  - `values.dataMonitors.validitySpan` (object)
    Period after which Business Partner is evaluated again.

  - `values.dataMonitors.validitySpan.technicalKey` (string)
    Validity span period.
    Example: "YEAR"

  - `values.dataMonitors.scopes` (array)
    Scope of data monitor.

  - `values.dataMonitors.scopes.technicalKey` (string)
    Data Monitor scope of selected products.

Augmentation Data Monitor may be one of:
* AUGMENTED_BUSINESS_PARTNERS - enables Business Partner Augmentation
* RAW_UPDATES - enables Raw Updates
* OVERLAP - enables Overlap

By default, when empty in Augmentation Data Monitor, below are enabled:
* AUGMENTED_BUSINESS_PARTNERS
* RAW_UPDATES
    Example: "RAW_UPDATES"

  - `values.dataMonitors.createdBy` (string)
    Creator of a resource.
    Example: "76248934691294444"

  - `values.dataMonitors.modifiedAt` (string)
    Date of modification (ISO 8601-compliant).
    Example: "2025-09-10T12:35:58Z"

  - `values.dataMonitors.modifiedBy` (string)
    User or Client UUID which modified the resource.
    Example: "76248934691294444"

  - `values.dataMonitors.featuresOn` (array)
    Features to be activated for Data Monitor.
    Example: ["BUILD_REPORT"]

  - `values.features` (object)
    Features of a storage.

  - `values.features.lookup` (object)
    Status of a feature.

  - `values.features.lookup.status` (string)
    Status of a feature.
    Enum: "ENABLED", "DISABLED"

  - `values.features.updates` (object)
    Status of a feature.

  - `values.features.sharing` (object)
    Status of a feature.

  - `values.features.neverExpire` (object)
    Status of a feature.

  - `values.features.tagsManagedByUpsert` (object)
    Status of a feature.

  - `values.numberOfCountries` (integer)
    Number of countries in the Business Partner Storage.
    Example: "12"

  - `values.numberOfRecords` (integer)
    Number of records in the Business Partner Storage.
    Example: "500"

  - `values.countryStatistics` (array)

  - `values.countryStatistics.countryCode` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `values.originalFileHeader` (array)
    List of headers used for a modification of metadata.
    Example: ["BusinessPartnerId, Name, Address"]

  - `values.originalFileName` (string)
    Name of the last file that was used to import data into this Business Partner Storage.
    Example: "business-partner.csv"

  - `values.results` (object)
    Results of a Business Partner Storage.

  - `values.results.addressCurationReports` (array)
    List of Address Curation Reports.

  - `values.results.addressCurationReports.creationTimestamp` (string)
    Date of creation (ISO 8601-compliant).
    Example: "2025-09-10T12:35:59Z"

  - `values.results.addressCurationReports.description` (string)
    Description of the Report.
    Example: "Report description"

  - `values.results.addressCurationReports.name` (string)
    Display Name of the Report.
    Example: "Report name"

  - `values.results.addressCurationReports.type` (string)
    Type of the Report.
    Example: "Report type"

  - `values.results.addressCurationReports.url` (string)
    URL of the Report.
    Example: "https://www.cdq.com"

  - `values.results.goldenRecordGenerationReports` (array)
    List of Golden Record Generation Reports.

  - `values.results.resultItems` (array)
    List of Result Items.

  - `values.results.resultItems.country` (string)
    Country code (ISO 3166-1 alpha-2).
    Example: "CH"

  - `values.results.resultItems.label` (string)
    Label of the Result Item.
    Example: "Result Item label"

  - `values.results.resultItems.type` (string)
    Type of the Result Item.
    Example: "Result Item type"

  - `values.results.validationReports` (array)
    List of Validation Reports.

  - `values.status` (string)
    Status of a Business Partner Storage.
    Example: "FILE_IMPORTED_SUCCESSFULLY"

  - `values.statusMessage` (string)
    Details related to status.
    Example: "BusinessPartner batch could not be upserted into Business Partner Storage."

  - `values.sharedWithOrganization` (boolean)
    Indicates if this Business Partner Storage is shared with all users of the same organization
    Example: "true"

  - `values.labels` (array)
    Labels to categorize the storage.
    Example: ["Custom Storage Name"]

  - `values.domain` (string)
    Domain of a Business Partner Storage.
    Example: "BusinessPartner"

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

  - `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"

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