API Reference
Splio Customer PlatformMobile Wallets

Point list by universe endpoint

get
https://api.splio.com/loyalty/points

Point list by universe endpoint

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error cases

Wrong cursor - see dedicated doc (400)

Wrong operator in search (400)

{
    "error_key": "id_individual",
    "error": "invalid_operator",
    "error_description": "begins_with isn't allowed for key id_individual. Use one of equals,not equals,contains,begins,ends"
}

Contact unique_key (in search, query param) not found (404)

{
    "status": 404,
    "errors": {
        "error_key": null,
        "error": "not_found",
        "error_description": "unique_key \"key_0\" not found in splio3_data.qa03"
    }
}

Program name (in search, query param) does not exist (404)

{
    "error_key": "program_name",
    "error": "invalid_program_name",
    "error_description": "program_name not found"
}
Query Params
string

Number max of results returned.

string

Cursor hash returned on your last call.

string

Cursor hash returned on your last call.

string
enum

Order of return point list (asc or desc).

Allowed:
string
enum

Sort by ID and/or EventDate.

Allowed:
string

Search on card_code. Format: {"operator":"equals","value":"my_card_code"}. Operators: equals, not equals, contains, begins, ends

string

Search on tier_name. Format: {"operator":"equals","value":"my_tier"}. Operators: equals, not equals, contains, begins, ends, is empty, is not empty

string

Search on id_program. Format: {"operator":"equals","value":"123"}. Operators: equals, not equals, gt, gte, lt, lte

string

Search on id_individual. Format: {"operator":"equals","value":"my_id"}. Operators: equals, not equals, contains, begins, ends

string

Search on rule_name. Format: {"operator":"equals","value":"my_rule"}. Operators: equals, not equals, contains, begins, ends, is empty, is not empty

string

Search on program_name. Format: {"operator":"equals","value":"my_program"}. Operators: equals, not equals, contains, begins, ends

string

Search on points_credited. Format: {"operator":"gte","value":"100"}. Operators: equals, not equals, gt, gte, lt, lte

string

Search on points_earned. Format: {"operator":"gte","value":"100"}. Operators: equals, not equals, gt, gte, lt, lte

string

Search on points_remaining. Format: {"operator":"gte","value":"50"}. Operators: equals, not equals, gt, gte, lt, lte

string

Search on event_date. Format: {"operator":"gte","value":"2024-01-01"}. Operators: equals, not equals, gt, gte, lt, lte, on date

string

Search on value_date. Format: {"operator":"gte","value":"2024-01-01"}. Operators: equals, not equals, gt, gte, lt, lte, on date

string
Defaults to {"operator":"equals","value":"nq"}

Search on points_type. Format: {"operator":"equals","value":"my_type"}. Operators: equals, not equals, contains, begins, ends

string

Search on validity_start. Format: {"operator":"gte","value":"2024-01-01"}. Operators: equals, not equals, gt, gte, lt, lte, on date

string

Search on validity_end. Format: {"operator":"gte","value":"2024-12-31"}. Operators: equals, not equals, gt, gte, lt, lte, on date

string

Search on status. Format: {"operator":"equals","value":"active"}. Operators: equals, not equals, contains, begins, ends

string
enum
Defaults to {"operator":"equals","value":"event"}

Search on event_type. Format: {"operator":"equals","value":"my_event"}. Operators: equals, not equals, contains, begins, ends

Responses

400

Wrong payload.

401

Authentication failed.

403

Forbidden.

500

Something went wrong.

Updated about 2 months ago

What’s Next

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

What’s Next

Did this page help you?