Get User
curl --request GET \
--url https://api-staging.withbenji.com/users/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api-staging.withbenji.com/users/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-staging.withbenji.com/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.withbenji.com/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.withbenji.com/users/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.withbenji.com/users/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.withbenji.com/users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"code": "ok",
"data": {
"user": {
"created_date": "2026-02-08T00:13:59.970754+00:00",
"email": "test@test.com",
"external_id": null,
"first_name": "Test",
"id": 155,
"last_name": "User",
"merchants": [
{
"created_date": "2026-02-09T14:50:17.198641+00:00",
"external_id": "4731354127758848",
"id": 196,
"merchant_id": 85,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 155
},
{
"created_date": "2026-02-11T18:08:18.532675+00:00",
"external_id": "daae5365-c895-48bf-bc23-a9861a351e04",
"id": 215,
"merchant_id": 93,
"total_rewards_earned": 3327,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"partner_status_tiers": [
{
"created_date": "2026-02-08T00:16:10.255945+00:00",
"external_id": "4731354127758848",
"first_name": "Test",
"id": 287,
"last_name": "User",
"partner_id": 61,
"partner_status_tier_id": 92,
"total_rewards": 8696,
"total_rewards_earned": 8873,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"phone_number": null,
"uuid_id": "77a5ad82-c27a-47fd-b21d-2d19a3ff222d"
}
}
}
{
"error": "invalid_token",
"message": "Invalid token"
}
{
"error": "unauthorized_request",
"message": "Token is not authorized to make this request"
}
{
"error": "user_does_not_exist",
"message": "The user does not exist"
}
Member API
Get User
Get a single user by ID
GET
/
users
/
{id}
Get User
curl --request GET \
--url https://api-staging.withbenji.com/users/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api-staging.withbenji.com/users/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-staging.withbenji.com/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.withbenji.com/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.withbenji.com/users/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.withbenji.com/users/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.withbenji.com/users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"code": "ok",
"data": {
"user": {
"created_date": "2026-02-08T00:13:59.970754+00:00",
"email": "test@test.com",
"external_id": null,
"first_name": "Test",
"id": 155,
"last_name": "User",
"merchants": [
{
"created_date": "2026-02-09T14:50:17.198641+00:00",
"external_id": "4731354127758848",
"id": 196,
"merchant_id": 85,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 155
},
{
"created_date": "2026-02-11T18:08:18.532675+00:00",
"external_id": "daae5365-c895-48bf-bc23-a9861a351e04",
"id": 215,
"merchant_id": 93,
"total_rewards_earned": 3327,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"partner_status_tiers": [
{
"created_date": "2026-02-08T00:16:10.255945+00:00",
"external_id": "4731354127758848",
"first_name": "Test",
"id": 287,
"last_name": "User",
"partner_id": 61,
"partner_status_tier_id": 92,
"total_rewards": 8696,
"total_rewards_earned": 8873,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"phone_number": null,
"uuid_id": "77a5ad82-c27a-47fd-b21d-2d19a3ff222d"
}
}
}
{
"error": "invalid_token",
"message": "Invalid token"
}
{
"error": "unauthorized_request",
"message": "Token is not authorized to make this request"
}
{
"error": "user_does_not_exist",
"message": "The user does not exist"
}
The
x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.string
required
Unique identifier of the user to retrieve (UUID)
Response
object
required
The requested user object containing all user details including personal information, partner statuses, and merchant associations.
Hide properties
Hide properties
string
required
UUID identifier for the user.
string
required
The user’s first name.
string
required
The user’s last name.
string
required
The user’s email address.
string
required
The user’s phone number in E.164 format.
string
required
The date and time when the user was created, in ISO 8601 format.
string
External system identifier for the user, if applicable.
array
List of partner status tier objects associated with the user. Each object contains details about the user’s status with a partner.
Show partner status tier properties
Show partner status tier properties
integer
Unique identifier for the partner status tier record.
integer
The user’s unique identifier.
integer
The partner’s unique identifier.
integer
The status tier’s unique identifier for this partner.
string
External system identifier for the partner status tier, if applicable.
string
First name as recorded for this partner status tier.
string
Last name as recorded for this partner status tier.
integer
Total rewards available for this partner status tier.
integer
Total rewards earned for this partner status tier.
integer
Total rewards redeemed for this partner status tier.
string
Date and time when this partner status tier was created.
array
List of merchant association objects for the user. Each object contains details about the user’s relationship with a merchant.
Show merchant properties
Show merchant properties
integer
Unique identifier for the user-merchant association record.
integer
The user’s unique identifier.
integer
The merchant’s unique identifier.
string
External system identifier for the merchant association, if applicable.
integer
Total rewards earned with this merchant.
integer
Total rewards redeemed with this merchant.
string
Date and time when this merchant association was created.
{
"code": "ok",
"data": {
"user": {
"created_date": "2026-02-08T00:13:59.970754+00:00",
"email": "test@test.com",
"external_id": null,
"first_name": "Test",
"id": 155,
"last_name": "User",
"merchants": [
{
"created_date": "2026-02-09T14:50:17.198641+00:00",
"external_id": "4731354127758848",
"id": 196,
"merchant_id": 85,
"total_rewards_earned": 0,
"total_rewards_redeemed": 0,
"user_id": 155
},
{
"created_date": "2026-02-11T18:08:18.532675+00:00",
"external_id": "daae5365-c895-48bf-bc23-a9861a351e04",
"id": 215,
"merchant_id": 93,
"total_rewards_earned": 3327,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"partner_status_tiers": [
{
"created_date": "2026-02-08T00:16:10.255945+00:00",
"external_id": "4731354127758848",
"first_name": "Test",
"id": 287,
"last_name": "User",
"partner_id": 61,
"partner_status_tier_id": 92,
"total_rewards": 8696,
"total_rewards_earned": 8873,
"total_rewards_redeemed": 0,
"user_id": 155
}
],
"phone_number": null,
"uuid_id": "77a5ad82-c27a-47fd-b21d-2d19a3ff222d"
}
}
}
{
"error": "invalid_token",
"message": "Invalid token"
}
{
"error": "unauthorized_request",
"message": "Token is not authorized to make this request"
}
{
"error": "user_does_not_exist",
"message": "The user does not exist"
}
This endpoint retrieves detailed information about a specific user, including their loyalty status with all connected partners and merchants.
Was this page helpful?