Skip to main content

Retrieve a list of rewards given to the user (by phone)

GET 
/api/users/by-phone/:phoneNumber/rewards

Retrieve a list of rewards in various states given to a user. The user is identified by the cell phone number of the user and in the format +1CCCBBBAAAA.

Request​

Path Parameters

    phoneNumber stringrequired

Responses​

List of rewards given to user.

Schema

  • Array [

    • id string

    Id of the reward

    status string

    Possible values: [Pending, Confirmed, Declined, Claimed, All]

    Status of the reward

    type string

    Possible values: [MileageCheckIn, ConditionCheckIn, GaragingCheckIn, LowMileageBonus, Custom, SurveyCompleted]

    Type of the reward

    description string

    Description of the reward

    vehicleId string

    Id of the vehicle (if the reward is tied to an action on the vehicle like a Mileage Check-in

    payoutId string

    Id of the payout (if the reward has been claimed.

    dateRewarded string

    Date on which reward was created

    buyer

    object

    Buyer of the reward

    id string

    Id of the buyer

    name string

    Name of the buyer

    logo string

    Logo of the buyer

    listLogo string

    Small Logo of the buyer

    description string

    Description of buyer

    shortDescription string

    Short description of the buyer

    earningsDescription string

    Description shown on the earnings tab of the buyer

    appDownloadLink string

    App download link

    websiteLink string

    Website link

    shopNowLink string

    Shop now link

    featured boolean

    Featured

    featuredHeroImage string

    Hero Image

    marketplacePhoto1 string

    Photo1

    marketplacePhoto2 string

    Photo2

    marketplacePhoto3 string

    Photo3

    marketplaceDescription string

    Description

    featuredImage string

    Image

    featuredBgColor string

    BgColor of the shop

    featuredTitle string

    Title of the shop

    amount double

  • ]

Loading...