Skip to main content
GET
/
customers
Search Customers
curl --request GET \
  --url https://app.stickyqr.com/api/customers/ \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "currentPage": 1,
  "pageSize": 20,
  "noCustomers": 123,
  "data": [
    {
      "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"

Query Parameters

pageNumber
string
default:1

The page number to retrieve.

Example:

"1"

pageSize
string
default:20

The number of items per page.

Example:

"50"

name
string

The name you want to search for

Example:

"John Doe"

Response

200 - application/json

Successful Response / Successfull Response

hasMore
boolean

Indicates whether more data pages are available

currentPage
number

The current page number

pageSize
number

The number of items returned per page

noCustomers
number

The number of customers returned in the current page

data
object[]