Get all stamper cards
Get a list of stamper cards from the CareCloud platform. ⚠️ If no card is returned for active campaign, that means a customer did not collect any stamps yet, so card was not created. After he collects fist stamp, the card will be automatically generated.
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.
The unique ID of the customer. GET /customers
The unique ID of the stamper campaign. The filter reduces data in the response related only to the selected stamper campaign. GET /stamper-campaigns In case you want to filter multiple options use array syntax: stamper_campaign_id[]=8bc8ca16f9c5039951021700a2&stamper_campaign_id[]=82c06812c0756528660784fef
State of the card. Possible values are: 0 - blocked / 1 - active
The filter where you can decide what kind of stamper card you want. If the filter is not use, all cards are returned. Possible values: true - Filter returns only cards that has all stamps / false - Filter returns all cards that have still free at least one for the stamp.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"stamper_cards": [
{
"stamper_card_id": "81eaeea13b8984a169c490a325",
"stamper_campaign_id": "8bed991c68a470e7aaeffbf048",
"customer_id": "8ea2591121e636086a4a9c0992",
"stamper_card_order": 2,
"stamps": [
{
"stamp_id": "81eaeea13b8984a169c490a325",
"customer_id": "8ea2591121e636086a4a9c0992",
"purchase_id": "81eaeea13b8984a169c490a325",
"stamper_card_id": "8bed991c68a470e7aaeffbf048",
"stamp_order": 7,
"stamper_condition_id": "8bed991c68a470e7aaeffbf048",
"created_at": "2024-07-15 17:26:34",
"last_change": "2025-03-15 17:26:34",
"state": 1
}
],
"created_at": "2023-03-28 16:59:49",
"last_change": "2019-07-15 17:26:34",
"state": 1
}
],
"total_items": 1
}
}