Get a member

GET/v1/members/{id}

GET/v1/members/me

Returns the member object. In the app, call /me to show the balance and tier progress on the rewards screen.

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

Guide

Members and sign-in

Path parameters#

idstring (uuid)Required
The member id. Not used with /me.

Response fields#

Returns 200 with Member

idstring (uuid)
unPLUG's id for the member. Store it next to your user record.
external_idstringNullable
Your id for the guest, up to 128 characters. null for a guest who has only earned at the register and isn't linked to your login yet.
Max Length 128
statusstring
active. The member.deleted webhook carries deleted; after that, calls about the member return 410 member_deleted.
One of active, deleted
first_namestringNullable
last_namestringNullable
emailstring (email)Nullable
Saved in lowercase.
phonestringNullable
E.164, for example +15125550142.
phone_verifiedboolean
true when you confirmed the guest owns the number, for example with an SMS code. Only verified phones link to existing members.
birthdaystring (date)Nullable
YYYY-MM-DD.
points_balanceinteger
Points the member has now. Never below zero.
lifetime_pointsinteger
All points ever earned, used for tiers. Spending doesn't lower it.
tierTierRef
id and name of the current tier.
Show attributesTierRef
- idstring (uuid)
- namestring
next_tierobjectNullable
id, name and points_needed (lifetime points still to earn). null at the top tier.
Show attributesHide attributes
- idstring (uuid)
- namestring
- points_neededinteger
communication_preferencesobject
Marketing consent: email_marketing, sms_marketing, push_marketing. See communication preferences.
Show attributesHide attributes
- email_marketingboolean
- sms_marketingboolean
- push_marketingboolean
metadataobject
Your own string values. Up to 20 keys, 500 characters each. Don't put personal data here.
linked_existingboolean
Only on create: true when an existing member was linked by verified phone.
enrolled_atstring (date-time)
When the guest joined the program.
created_atstring (date-time)
updated_atstring (date-time)

GET/v1/members/{id}

1
2curl $UNPLUG_API/members/me \
  -H "Authorization: Bearer $MEMBER_TOKEN"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/members/me`, {
  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",
    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{
  "id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
  "external_id": "usr_10482",
  "status": "active",
  "first_name": "Maya",
  "last_name": "Lopez",
  "email": "maya@example.com",
  "phone": "+15125550142",
  "phone_verified": true,
  "birthday": "1994-03-18",
  "points_balance": 420,
  "lifetime_points": 1880,
  "tier": { "id": "2b9e4f7a-1c3d-4e6b-8a5f-9d0c2e7b4a13", "name": "Green" },
  "next_tier": { "id": "6f1a8c3d-9b2e-4d7a-b5c6-3e0f8a1d2b47", "name": "Gold", "points_needed": 120 },
  "communication_preferences": { "email_marketing": true, "sms_marketing": false, "push_marketing": true },
  "metadata": { "favorite_store": "south-congress" },
  "enrolled_at": "2025-06-14T15:02:44Z",
  "created_at": "2025-06-14T15:02:44Z",
  "updated_at": "2026-11-01T16:12:41Z"
}

Error descriptions#

401Unauthorized

token_expired

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

404Not found

member_not_found

No member with this id in your brand.

410Gone

member_deleted

The member was deleted. Unlink them from your user record.

Any endpoint can also return the common errors.

401 Unauthorized

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#token_expired",
  "title": "Unauthorized",
  "status": 401,
  "code": "token_expired",
  "detail": "The member token expired or was revoked. Get a new one from your server."
}