List a member's challenges from your server Coming soon

GET/v1/members/{id}/challenges

The same as List a member's challenges, for a server-to-server integration. Take the member id from your own signed-in session, never from a value the app sends.

Permissions: Secret key with members:read.

Guide

Challenges

Path parameters#

idstring (uuid)Required
The member id.

Query parameters#

limitinteger
Min 1Max 100Default 25
cursorstring
next_cursor from the previous page.

Response fields#

Returns 200 with list of MemberChallenge

dataarray of MemberChallenge
Show attributesMemberChallenge
- challenge_idstring (uuid)
  The challenge.
- member_idstring (uuid)
- statusstring
  eligible (can join, not joined), enrolled, completed or expired.
  One of eligible, enrolled, completed, expired
- progressobject
  current, target and unit. For streaks, periods lists each day or week with starts_at, ends_at and met; it's empty for other types.
  Show attributesHide attributes
  - currentinteger
  - targetinteger
  - unitstring
    One of visits, periods, cents, items
  - periodsarray of object
    Show attributesHide attributes
    starts_atstring (date-time)
    ends_atstring (date-time)
    metboolean
- window_ends_atstring (date-time)Nullable
  When this member's window ends. For a rolling challenge they haven't joined, null.
- completed_atstring (date-time)Nullable
  When they completed it, or null.
- reward_wallet_item_idstring (uuid)Nullable
  The wallet item paid on completion, for catalog rewards. null otherwise.
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/members/{id}/challenges

1
2curl https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/challenges \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch("https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/challenges", {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

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

response = requests.get(
    "https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/challenges",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
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{
  "data": [
    {
      "challenge_id": "4f9a2d61-3e8b-4c15-a7d0-b26e81f5c93a",
      "status": "enrolled",
      "progress": { "current": 2, "target": 3, "unit": "visits", "periods": [] },
      "window_ends_at": "2026-11-09T06:00:00Z",
      "completed_at": null,
      "reward_wallet_item_id": null
    },
    {
      "challenge_id": "d1e83b5c-7f02-4a69-9c4e-5b1a07d8e236",
      "status": "eligible",
      "progress": { "current": 0, "target": 4, "unit": "periods", "periods": [] },
      "window_ends_at": "2026-12-07T06:00:00Z",
      "completed_at": null,
      "reward_wallet_item_id": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Error descriptions#

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.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#member_not_found",
  "title": "Not found",
  "status": 404,
  "code": "member_not_found",
  "detail": "No member with this id."
}