API Reference

Get all stamper cards

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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.

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.

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.

string
enum

Direction of sorting the response list.

Allowed:
string

The unique ID of the customer.

string

The unique ID of the stamper campaign. The filter reduces data in the response related only to the selected stamper campaign.
In case you want to filter multiple options use array syntax: stamper_campaign_id[]=8bc8ca16f9c5039951021700a2&stamper_campaign_id[]=82c06812c0756528660784fef

integer
enum

State of the card. Possible values are: 0 - blocked / 1 - active

Allowed:
string

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
string
Defaults to cs, en-gb;q=0.8

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

Responses

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.

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago