# List delivery configurations

Endpoint: GET /integrations/deliveryconfig
Version: 1.0.457.36910
Security: OAuth2

## Security:

  - `OAuth2` (unknown)
    oauth2 scopes: FullAccess, DeliveryConfigAdmin

## Query parameters:

  - `search` (string)
    Word or phrase to search for.

  - `searchOn` (array)
    Comma-delimited list of fields to search on.

  - `sortBy` (array)
    Comma-delimited list of fields to sort by.

  - `page` (integer)
    Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

  - `pageSize` (integer)
    Number of results to return per page.

  - `filters` (object)
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

## Response 200 fields (application/json):

  - `Items` (array)

  - `Items.ID` (string)

  - `Items.Name` (string)

  - `Items.Enabled` (boolean)

  - `Items.DeliveryTargets` (object)
    Example: {"Kafka":{"BootstrapServers":"","SaslUsername":"","SaslPassword":"","Topic":""},"Http":{"Endpoint":"","Secret":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"SearchIngestion":{"Domain":"","…

  - `Items.DeliveryTargets.Kafka` (object)
    Example: {"BootstrapServers":"","SaslUsername":"","SaslPassword":"","Topic":""}

  - `Items.DeliveryTargets.Kafka.BootstrapServers` (string)

  - `Items.DeliveryTargets.Kafka.SaslUsername` (string)

  - `Items.DeliveryTargets.Kafka.SaslPassword` (string)

  - `Items.DeliveryTargets.Kafka.Topic` (string)

  - `Items.DeliveryTargets.Http` (object)
    Example: {"Endpoint":"","Secret":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}

  - `Items.DeliveryTargets.Http.Endpoint` (string)

  - `Items.DeliveryTargets.Http.Secret` (string)

  - `Items.DeliveryTargets.Http.CustomAuthHeaderName` (string)

  - `Items.DeliveryTargets.Http.CustomAuthHeaderValue` (string)

  - `Items.DeliveryTargets.SearchIngestion` (object)
    Example: {"Domain":"","Source":"","Endpoint":"","Entity":"","ApiKey":"","Content":{"Locales":[""],"Http":{"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}}}

  - `Items.DeliveryTargets.SearchIngestion.Domain` (string)

  - `Items.DeliveryTargets.SearchIngestion.Source` (string)

  - `Items.DeliveryTargets.SearchIngestion.Endpoint` (string)

  - `Items.DeliveryTargets.SearchIngestion.Entity` (string)

  - `Items.DeliveryTargets.SearchIngestion.ApiKey` (string)

  - `Items.DeliveryTargets.SearchIngestion.Content` (object)
    Example: {"Locales":[""],"Http":{"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}}

  - `Items.DeliveryTargets.SearchIngestion.Content.Locales` (array)
    Supported search ingestion locales.

  - `Items.DeliveryTargets.SearchIngestion.Content.Http` (object)
    Example: {"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}

  - `Items.DeliveryTargets.SearchIngestion.Content.Http.Endpoint` (string)

  - `Items.DeliveryTargets.SearchIngestion.Content.Http.CustomAuthHeaderName` (string)
    Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.

  - `Items.DeliveryTargets.SearchIngestion.Content.Http.CustomAuthHeaderValue` (string)
    The header value that can be passed to your middleware.

  - `Items.DeliveryTargets.SendEvent` (object)
    Example: {"SiteID":"","ServiceEndpoint":""}

  - `Items.DeliveryTargets.SendEvent.SiteID` (string)

  - `Items.DeliveryTargets.SendEvent.ServiceEndpoint` (string)

  - `Items.DeliveryTargets.DiscoverEvent` (object)
    Example: {"ClientID":"","ApiKey":"","ServiceEndpoint":""}

  - `Items.DeliveryTargets.DiscoverEvent.ClientID` (string)

  - `Items.DeliveryTargets.DiscoverEvent.ApiKey` (string)

  - `Items.DeliveryTargets.DiscoverEvent.ServiceEndpoint` (string)

  - `Items.DeliveryTargets.EventHub` (object)
    Example: {"EventHubName":"","ConnectionString":""}

  - `Items.DeliveryTargets.EventHub.EventHubName` (string)

  - `Items.DeliveryTargets.EventHub.ConnectionString` (string)

  - `Items.DeliveryTargets.AzureBlob` (object)
    Example: {"ConnectionString":"","OverrideContainerName":""}

  - `Items.DeliveryTargets.AzureBlob.ConnectionString` (string)
    Storage account connection string.

  - `Items.DeliveryTargets.AzureBlob.OverrideContainerName` (string)

  - `Items.DeliveryTargets.AzureTable` (object)
    Example: {"ConnectionString":"","OverrideTableName":""}

  - `Items.DeliveryTargets.AzureTable.ConnectionString` (string)
    Storage account connection string.

  - `Items.DeliveryTargets.AzureTable.OverrideTableName` (string)

  - `Items.DeliveryTargets.CosmosDb` (object)
    Example: {"ConnectionString":"","OverrideDatabaseName":""}

  - `Items.DeliveryTargets.CosmosDb.ConnectionString` (string)
    Storage account connection string.

  - `Items.DeliveryTargets.CosmosDb.OverrideDatabaseName` (string)

  - `Items.DeliveryTargets.Mailchimp` (object)
    Example: {"ApiKey":""}

  - `Items.DeliveryTargets.Mailchimp.ApiKey` (string)
    The Mailchimp API key. If this property is not set, the default OrderCloud Mailchimp instance is used. The default instance is intended for test purposes only.

  - `Items.DeliveryTargets.MessageSender` (object)
    Example: {"Secret":"","Endpoint":""}

  - `Items.DeliveryTargets.MessageSender.Secret` (string)

  - `Items.DeliveryTargets.MessageSender.Endpoint` (string)

  - `Items.DeliveryTargets.ContentHub` (object)
    Example: {"ApiKey":"","Endpoint":"","TargetSchemaName":"","ConfigData":{}}

  - `Items.DeliveryTargets.ContentHub.ApiKey` (string)

  - `Items.DeliveryTargets.ContentHub.Endpoint` (string)

  - `Items.DeliveryTargets.ContentHub.TargetSchemaName` (string)

  - `Items.DeliveryTargets.ContentHub.ConfigData` (object)
    Any custom property mapping should be included here.

  - `Meta` (object)

  - `Meta.Page` (integer)

  - `Meta.PageSize` (integer)

  - `Meta.TotalCount` (integer)

  - `Meta.TotalPages` (integer)

  - `Meta.ItemRange` (array)

  - `Meta.NextPageKey` (string)

## Response 4XX:

  - `4XX` (unknown)
    Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.

## Response 4XX fields (application/json):

  - `StatusCode` (integer)
    Example: 404

  - `ErrorCode` (string)
    Example: NotFoundError

  - `Message` (string)
    Example: Object not found

  - `Data` (object)
    Example: {"ObjectType":"","ObjectID":""}

