List activity

GET/v1/members/{id}/activity

GET/v1/members/me/activity

Returns the member's activity, newest first. Use it for the points history screen.

Permissions: {id}: secret key with members:read. me: member token.

Guide

Points and rewards

Path parameters#

idstring (uuid)Required

Query parameters#

fromstring (date-time)
RFC 3339 time. Entries created at or after it.
tostring (date-time)
RFC 3339 time. Entries created before it.
typestring
One entry type, for example earn.
One of earn, bonus, redeem, adjust, reverse, expire
limitinteger
1 to 100. Default 25.
Min 1Max 100Default 25
cursorstring
next_cursor from the previous page. Send the same filters with it. See Pagination.

The last two entries belong to one order: Maya spent 500 Beans on a free drip coffee, then earned 43 on what she paid for. Reading up the list, each balance_after is the one below it plus that entry's points: 265, 308, 358, 420.

Response fields#

Returns 200 with list of ActivityEntry

dataarray of ActivityEntry
Show attributesActivityEntry
- idstring (uuid)
- typestring
  What happened. See the table below. May grow.
  One of earn, bonus, redeem, adjust, reverse, expire
- pointsinteger
  Signed change: 62 for an earn, -500 for a redeem.
- balance_afterinteger
  The member's points_balance right after this entry.
- descriptionstring
  A short line you can show the guest, for example Visit at South Congress or Free drip coffee.
- order_idstring (uuid)Nullable
  The order that caused it, for earn, bonus, redeem and reverse.
- reward_idstring (uuid)Nullable
  The reward bought, for redeem.
- adjustment_reasonstringNullable
  For adjust: goodwill, correction, migration or other.
  One of goodwill, correction, migration, other
- created_atstring (date-time)
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/members/{id}/activity

1
2curl "$UNPLUG_API/members/me/activity?limit=4" \
  -H "Authorization: Bearer $MEMBER_TOKEN"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/members/me/activity?limit=4`, {
  headers: {
    Authorization: `Bearer ${process.env.MEMBER_TOKEN}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    f"{os.environ['UNPLUG_API']}/members/me/activity?limit=4",
    headers={
        "Authorization": f"Bearer {os.environ['MEMBER_TOKEN']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50{
  "data": [
    {
      "id": "c2e8a4f1-6b3d-4e9a-8c7f-1d5b0e3a9c26",
      "type": "earn",
      "points": 62,
      "balance_after": 420,
      "description": "Visit at South Congress",
      "order_id": "5d9b3e7f-1a4c-4f8e-b2d6-0c7a9e1f3b58",
      "reward_id": null,
      "adjustment_reason": null,
      "created_at": "2026-11-01T16:12:40Z"
    },
    {
      "id": "f7a3c9e2-4d1b-4b6f-9e8a-2c0d5f7b1e43",
      "type": "adjust",
      "points": 50,
      "balance_after": 358,
      "description": "Courtesy points",
      "order_id": null,
      "reward_id": null,
      "adjustment_reason": "goodwill",
      "created_at": "2026-10-27T13:05:18Z"
    },
    {
      "id": "1b6d8f2a-9c4e-4a7d-b3f1-6e0c2a8d5f97",
      "type": "earn",
      "points": 43,
      "balance_after": 308,
      "description": "Visit at South Congress",
      "order_id": "a3f7d1c9-5e2b-4c8a-9f6d-4b1e7c3a0d82",
      "reward_id": null,
      "adjustment_reason": null,
      "created_at": "2026-10-20T14:31:05Z"
    },
    {
      "id": "6e0a2c8d-3f7b-4d1e-a5c9-8b4f1d6e2a30",
      "type": "redeem",
      "points": -500,
      "balance_after": 265,
      "description": "Free drip coffee",
      "order_id": "a3f7d1c9-5e2b-4c8a-9f6d-4b1e7c3a0d82",
      "reward_id": "9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98",
      "adjustment_reason": null,
      "created_at": "2026-10-20T14:31:02Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJjIjoiMjAyNi0xMC0yMFQxNDozMTowMloifQ"
}

Error descriptions#

400Bad request

invalid_param

from or to isn't an RFC 3339 time, or type isn't an entry type.

401Unauthorized

token_expired

The member token expired. Get a new one from your server.

404Not found

member_not_found

No member with this id.

410Gone

member_deleted

The member was deleted.

Any endpoint can also return the common errors.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#invalid_param",
  "title": "Bad request",
  "status": 400,
  "code": "invalid_param",
  "detail": "from or to isn't an RFC 3339 time, or type isn't an entry type."
}