Get all point records

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

Get a list of all point transactions and their current values.

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.

customer_id

string

The unique ID of the customer.

point_type_id

string

The unique ID of a point type.

create_point_time_from

string

Date and time from of the create point record. (YYYY-MM-DD HH:MM:SS)

create_point_time_to

string

Date and time to of the create point record. (YYYY-MM-DD HH:MM:SS)

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

points

array of objects

List of the point records.

points

object

point_id

string

The unique ID of the point record.

customer_id

string

required

The unique ID of the customer.

assigned_points

float

The number of earned points.

available_points

float

The number of points available actually taking into account the eventual points redemption.

point_type_id

string

required

Type of the point record.

partner_id

string

required

The unique ID of the partner company.

valid_to

string

Date and time of the point record validity to. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the point record.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

created_at

string

Date and time of point record creation. Possible value: 2016-06-30T15:51:49+02:00

note

string

Note for the new point record.

total_items

integer

The number of all found point records.

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/points?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
19
 
1
{
2
  "data": {
3
    "points": [
4
      {
5
        "point_id": "8bd48117006496e0b1788109b8",
6
        "customer_id": "87af991126405bf8e7dfb36045",
7
        "assigned_points": 50,
8
        "available_points": 700,
9
        "point_type_id": "81eaeea13b8984a169c490a325",
10
        "partner_id": "86e05affc7a7abefcd513ab400",
11
        "valid_to": "2023-09-16 23:59:59",
12
        "state": 1,
13
        "created_at": "2016-06-30T15:5:49+02:00",
14
        "note": "Birthdate point reward"
15
      }
16
    ],
17
    "total_items": 1
18
  }
19
}

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.