v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Campaign products

Get a campaign product store records

Get all store records associated with a specific campaign product. Store records define which stores the campaign product applies to. See Campaign products for details.

get/campaign-products/{campaign_product_id}/campaign-product-store-records

Path parameters

campaign_product_idstring required

The unique ID of the campaign product in CareCloud.

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "campaign_product_store_records": [
      {
        "campaign_product_store_record_id": "8bed991c68a470e7aaeffbf048",
        "store_id": "8bed991c68a470e7aaeffbf048",
        "campaign_product_id": "81eaeea13b8984a169c490a325"
      }
    ],
    "total_items": 1
  }
}