Skip to main content

Retrieve a summary of all check-ins for a user

GET 
/api/users/:userId/summary

Retrieve a summary of all check-ins for a user. This includes mileage, condition and service check-ins.

Request​

Path Parameters

    userId stringrequired

Responses​

A summary of check-in information about the user.

Schema

  • Array [

    • user

    object

    id string

    Unique Id for the user

    firstName string

    User's first name

    lastName string

    User's last name

    email string

    User's email address

    phone string

    User's cell phone number

    adminNote string

    Internal admin note

    customField1 string

    Custom Field 1

    customField2 string

    Custom Field 2

    customField3 string

    Custom Field 3

    customField4 string

    Custom Field 4

    customField5 string

    Custom Field 5

    address

    object

    Address

    addressLine1 string

    Street Address Line 1

    addressLine2 string

    Street Address Line 2

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

    tosAnswer string

    Possible values: [None, Accepted, Declined]

    User's answer to terms of service for sharing data with Partner. (Only valid for certain partners)

    partnerCode string

    A code generated for the user to share with Partner. (Only valid for certain partners)

    dateRegistered string

    Time at which user was registered on the system

    updated string

    Last updated timestamp

    emailVerified boolean
    phoneVerified boolean
    fraud boolean

    vehicles

    object[]

    Vehicles owned by user

  • Array [

    • id string

    Id of the vehicle

    license string

    License plate number

    make string

    Make of the vehicle

    model string

    Model of the vehicle

    vin string

    VIN of the vehicle.

    state string

    2 Letter State Code (eg. AL, CA, CO etc.)

    mileageCheckinSummary

    object

    A summary of mileage check-ins for a vehicle.

    checkins

    object[]

    List of all check-ins

  • Array [

    • id string

    Id of the check-in

    checkInType string

    Type of the check-in

    status string

    Status of the check-in

    checkinDate string

    Timestamp of the check-in

    adminNote string

    Admin generated note. Usually used for on-hold or declined check-ins

    reward

    object

    Reward associated with the check-in

    id string

    Id of the reward

    status string

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

    Status of the reward

    dateRewarded string

    Date on which reward was created

    amount double

  • ]

    • checkinUnlocked boolean

    Is a check-in unlocked.

    unlockDate string

    If the check-in is unlocked, the time at which it was unlocked.

    daysToNextCheckin int64

    Number of days to next check-in.

    rewardAmountForNextCheckin double

    Reward for next check-in based on current campaign setup.

    lastConfirmedOrdinal int32

    The ordinal of the last confirmed check-in. 0 represents no confirmed check-ins

    lastConfirmedMileage int64

    Mileage of last confirmed check-in.

    conditionCheckinSummary

    object

    A summary of condition check-ins for a vehicle.

    checkins

    object[]

    List of all check-ins

  • Array [

    • id string

    Id of the check-in

    checkInType string

    Type of the check-in

    status string

    Status of the check-in

    checkinDate string

    Timestamp of the check-in

    adminNote string

    Admin generated note. Usually used for on-hold or declined check-ins

    reward

    object

    Reward associated with the check-in

    id string

    Id of the reward

    status string

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

    Status of the reward

    dateRewarded string

    Date on which reward was created

    amount double

  • ]

    • checkinUnlocked boolean

    Is a check-in unlocked.

    unlockDate string

    If the check-in is unlocked, the time at which it was unlocked.

    daysToNextCheckin int64

    Number of days to next check-in.

    rewardAmountForNextCheckin double

    Reward for next check-in based on current campaign setup.

    lastConfirmedOrdinal int32

    The ordinal of the last confirmed check-in. 0 represents no confirmed check-ins

  • ]

    • proofOfAddressCheckins

    object

    A summary of proof of address check-ins for a vehicle.

    checkins

    object[]

    List of all check-ins

  • Array [

    • id string

    Id of the check-in

    checkInType string

    Type of the check-in

    status string

    Status of the check-in

    checkinDate string

    Timestamp of the check-in

    adminNote string

    Admin generated note. Usually used for on-hold or declined check-ins

    reward

    object

    Reward associated with the check-in

    id string

    Id of the reward

    status string

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

    Status of the reward

    dateRewarded string

    Date on which reward was created

    amount double

    address

    object

    Address

    addressLine1 string

    Street Address Line 1

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

    latitude double

    Latitude at which photo was taken

    longitude double

    Longitude at which photo was taken

  • ]

    • checkinUnlocked boolean

    Is a check-in unlocked.

    unlockDate string

    If the check-in is unlocked, the time at which it was unlocked.

    daysToNextCheckin int64

    Number of days to next check-in.

    rewardAmountForNextCheckin double

    Reward for next check-in based on current campaign setup.

    photoBonusForNextCheckin double

    Bonus for home photos for next check-in based on current campaign setup.

    lastConfirmedOrdinal int32

    The ordinal of the last confirmed check-in. 0 represents no confirmed check-ins

  • ]

Loading...