Get all stamper campaigns

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/stamper-campaigns

Get a list of stamper campaigns from CRM CareCloud.

Query Params

count

integer

≥ 1

Defaults to 100

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.

offset

integer

≥ 0

Defaults to 0

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

sort_field

string

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

string

Direction of sorting the response list.

name

string

Search record by name or a part of the name.

valid_from

string

Date and time from when is record already valid. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date and time to when is record still valid. (YYYY-MM-DD HH:MM:SS)

partner_id

string

Unique ID of the partner from the resource GET /partners.

is_valid

boolean

in validity range - true / before or after validity range - false / no value - all

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

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

Responses

Response body

object

data

object

stamper_campaigns

array of objects

List of stamper campaigns.

stamper_campaigns

object

stamper_campaign_id

string

The unique ID of the stamper campaign.

partner_id

string

The unique ID of the CareCloud partner.

name

string

Name of the stamper campaign. The translation is return depending on the language value in the HTTP request header Accept-Language.

description

string

Description of the stamper campaign. The translation is return depending on the language value in the HTTP request header Accept-Language.

stamp_count

integer

The amount of stamps on the stamp card.

valid_from

string

Stamp campaign validity from. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Stamp campaign validity to. (YYYY-MM-DD HH:MM:SS)

amount_of_campaign_repetitions

integer

The number how many times can be campaign repeated. The number says how many stamper cards could be filled by customer in that campaign.

stamper_conditions

array of objects

List of defined stamper conditions.

stamper_conditions

object

stamper_condition_id

string

The unique ID of the stamper condition.

description

string

Stamper condition description. The translation is return depending on the language value in the HTTP request header Accept-Language.

stamper_bonus_checkpoints

array of objects

List of defined stamper checkpoints for bonuses.

stamper_bonus_checkpoints

object

stamper_bonus_checkpoint_id

string

The unique ID of the stamper bonus checkpoint.

description

string

Stamper bonus checkpoint description. The translation is return depending on the language value in the HTTP request header Accept-Language.

stamp_number

integer

Number of stamp in the stamp card that unlock the bonus checkpoint.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the stamper campaign.
Possible values are: 0 - deleted / 1 - active

1

total_items

integer

The number of all found stamper campaigns.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/stamper-campaigns?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
32
}
1
{
2
  "data": {
3
    "stamper_campaigns": [
4
      {
5
        "stamper_campaign_id": "81eaeea13b8984a169c490a325",
6
        "partner_id": "8bed991c68a470e7aaeffbf048",
7
        "name": "First customers",
8
        "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",
9
        "stamp_count": 10,
10
        "valid_from": "2025-03-15 17:00:00",
11
        "valid_to": "2025-07-15 17:00:00",
12
        "amount_of_campaign_repetitions": 3,
13
        "stamper_conditions": [
14
          {
15
            "stamper_condition_id": "8bd48117006496e0b1788109b8",
16
            "description": "Buy 2 doughnuts"
17
          }
18
        ],
19
        "stamper_bonus_checkpoints": [
20
          {
21
            "stamper_bonus_checkpoint_id": "8bd48117006496e0b1788109b8",
22
            "description": "5% off next purchase",
23
            "stamp_number": 5
24
          }
25
        ],

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.