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

GET 
https://api.sandbox.ownli.app/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

Header Parameters

partnerId stringrequired

Partner Id

clientId stringrequired

Client Id

clientSecret stringrequired

Client Secret

Responses

200

List of rewards given to user.

application/json

Schema

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

amount double

• ]

Example (from schema)

[
  {
    "id": "string",
    "status": "Pending",
    "type": "MileageCheckIn",
    "description": "string",
    "vehicleId": "string",
    "payoutId": "string",
    "dateRewarded": "string",
    "amount": 0
  }
]

401

Authorization error e.g. due to an invalid or missing API keys.

403

Forbidden. Possible error codes

1. ERROR_NO_PERMISSIONS_TO_RESOURCE

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

404

User not found. Possible error codes

1. ERROR_USER_NOT_FOUND

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

500

Internal error. Possible error codes

1. INTERNAL_SERVER_ERROR

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.sandbox.ownli.app/api/users/by-phone/:phoneNumber/rewards' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://api.sandbox.ownli.app

Parameters

phoneNumber — pathrequired

partnerId — headerrequired

clientId — headerrequired

clientSecret — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!