List rewards

GET

/rewards

const url = 'https://kmlrvcofvtzdlbomxrbp.supabase.co/functions/v1/external-api/rewards?limit=100&format=json&include_archived=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://kmlrvcofvtzdlbomxrbp.supabase.co/functions/v1/external-api/rewards?limit=100&format=json&include_archived=true' \
  --header 'Authorization: Bearer <token>'

Your company’s reward catalogue, newest first. Archived rewards are left out unless you ask for them. Requires the read:rewards scope.

Authorizations

bearerKey
headerKey

Parameters

Query Parameters

limit

integer

default: 100 >= 1 <= 1000

How many rows to return, 1 to 1000.

format

string

default: json

Allowed values: json csv

csv returns the same rows as CSV, for Excel, Google Sheets or Power BI.

include_archived

string

Allowed values: true

Responses

200

Rewards, newest first.

Array<object>

object

string format: uuid

name

string

description

string | null

points_cost

integer

reward_type

string

stock_count

integer | null

image_url

string | null

vendor_name

string | null

is_archived

boolean

created_at

string format: date-time

Example

[
  {
    "reward_type": "perk"
  }
]

401

The key is missing, malformed or revoked.

application/json

object

error

string

Example

{
  "error": "Unauthorized: Invalid or missing API Key"
}

403

The key works but does not have the scope this endpoint needs.

application/json

object

error

string

Example

{
  "error": "Forbidden: this key is missing the \"read:members\" scope"
}

500

Something went wrong on our side. The response does not include details.

application/json

object

error

string

Example

{
  "error": "Internal Server Error"
}