Get all stamper campaigns
Get a list of stamper campaigns from the CareCloud platform.
Query parameters
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.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
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.
Direction of sorting the response list.
Search record by name or a part of the name.
Start of the validity period for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.
End of the validity period for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.
Unique ID of the partner from the resource GET /partners.
in validity range - true / before or after validity range - false / no value - all
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"stamper_campaigns": [
{
"stamper_campaign_id": "81eaeea13b8984a169c490a325",
"partner_id": "8bed991c68a470e7aaeffbf048",
"name": "First customers",
"description": "Be among the first to join our exclusive loyalty program and start collecting digital stamps! For every purchase, you earn a stamp—collect 10 stamps to unlock a special reward. As a bonus, stamp #5 is a checkpoint that gives you an extra perk along the way! Start stamping today and enjoy exclusive rewards!\n",
"stamp_count": 10,
"valid_from": "2025-03-15 17:00:00",
"valid_to": "2025-07-15 17:00:00",
"count_of_campaign_repetitions": 3,
"stamper_conditions": [
{
"stamper_condition_id": "8bd48117006496e0b1788109b8",
"description": "Buy 2 doughnuts"
}
],
"stamper_bonus_checkpoints": [
{
"stamper_bonus_checkpoint_id": "8bd48117006496e0b1788109b8",
"description": "5% off next purchase",
"stamp_number": 5
}
],
"last_change": "2024-07-15 17:26:34",
"state": 1
}
],
"total_items": 1
}
}