Skip to main content
GET
/
perks
/
{perkId}
Get a single perk
curl --request GET \
  --url https://v2.api.us.housr.com/partners/perks/{perkId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "category": "<string>",
  "merchant_name": "<string>",
  "image_url": "<string>",
  "discount_text": "<string>",
  "terms": "<string>",
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_to": "2023-11-07T05:31:56Z",
  "city": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

perkId
string
required

Response

A single perk

id
string
title
string
description
string
category
string | null
merchant_name
string | null
image_url
string<uri> | null
discount_text
string | null
terms
string | null
valid_from
string<date-time> | null
valid_to
string<date-time> | null
city
string
created_at
string<date-time>
updated_at
string<date-time>