BYbyaccrue
Rewards

List Issued Rewards

List rewards issued to a recipient. Returns a paginated list of unified Reward resources that may include both immediate credits and pre-issued rewards. filter[phoneNumber] is required. When filter[status] is provided, only pre-issued rewards matching that status are returned.

get/api/v1/rewards

Request

Query parameters

filter[phoneNumber]string

Recipient phone number to look up (required).

Example:+15551234567
filter[status]string

When set, filters to pre-issued rewards with this status only (Created, Claimed, Expired, or Cancelled).

Example:Created
page[limit]number

Maximum number of objects that will be returned. Can not be greater than 50.

page[offset]number

Offset from the beginning of the list of objects. Can not be negative.

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "kind": "immediate",
        "amount": 500,
        "walletId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "status": "Credited",
        "claimExpiresAt": "2026-09-15T12:00:00.000Z",
        "message": "Thank you for your loyalty!",
        "reasonCode": "CX-COMPENSATION-001",
        "costCenter": "CX-SUPPORT",
        "notificationEmail": "agent@partner.example"
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.