Skip to main content
GET
/
customers
/
{id}
Get Customer By Id
curl --request GET \
  --url https://app.stickyqr.com/api/customers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "avatar": "<string",
  "balance": 123,
  "lifetimePoints": 123
}

Authorizations

Authorization
string
header
required

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

Headers

x-lang
string
default:en

Language support

Example:

"en"

Path Parameters

id
string
required

Depends on the type parameter. Id, phone or email of customer

Example:

"+12345678999"

Query Parameters

type
string
required

id | phone | email

Example:

"phone"

Response

200 - application/json

Successfull Response

id
string

Customer's id

name
string | null

Customer's name

phone
string

Customer's phone

email
string | null

Customer's email

avatar
string

Link of customer's avatar

balance
number

Current balance of customer

lifetimePoints
number

The cumulative points earned, excluding redeemed points