Skip to main content
GET
/
perks
/
users
/
{userId}
Get list of perks for a user
curl --request GET \
  --url https://v2.api.us.housr.com/partners/perks/users/{userId} \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

userId
string
required

Query Parameters

type
enum<string>
default:available
Available options:
available,
redeemed
page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100
sort
string

e.g. sort=title,-created_at

Response

OK

data
object[]
meta
object