Skip to main content
GET
Browse Profile Credits

Filtering

This endpoint accepts filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.

Examples

Operators

Filter attributes

Each attribute above is also a valid sort key, for example ?sort=-issued_at for descending order. Dot notation filters on a related record. Use not_has to exclude rows that have a matching related record. Related attributes are filter only, not sort keys.

Custom field filters

Credit records carry custom fields, so this endpoint also accepts filter[custom_field][namespace:handle].
Returns a paginated list of credits belonging to the specified profile. Credits represent monetary or point-based balances that have been issued to a profile, typically as part of a loyalty program incentive.

Path Parameters

string
required
The profile ID or handle to retrieve credits for.

Response

A successful request returns a 200 status code with an array of credit objects.
array
List of credit records associated with the profile.
Credits are distinct from points. Credits typically represent a dollar value, while points are earned and redeemed at defined rates.

Path Parameters

profile
string<uuid>
required

The profile ID

Query Parameters

page[size]
string

Response

Array of Credit

data
Credit · object[]
required