Skip to main content
GET
/
customerstats
/
customers
Customer list
curl --request GET \
  --url https://app.xmenu.it/api/customerstats/customers \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "page": 123,
  "pagesize": 123,
  "total_count": 123,
  "more": true,
  "customers": [
    {
      "email": "<string>",
      "uid": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "number": "<string>",
      "city": "<string>",
      "province": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "orders_count": 123,
      "pickup_orders_count": 123,
      "delivery_orders_count": 123,
      "offline_orders_count": 123,
      "first_order": "<string>",
      "last_order": "<string>",
      "last_offline_order": "<string>",
      "orders_total": 123,
      "added": "<string>",
      "signedup": true,
      "signup_uid": "<string>",
      "devices_unregistered": "<string>",
      "code": "<string>",
      "subrestaurant_code": "<string>",
      "subrestaurant_uid": "<string>",
      "signup_deleted": "<string>"
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Restaurant API Key. Can be obtained from Tools > API Access in the xMenu dashboard.

Query Parameters

​
restuid
string
required

Unique restaurant identifier

​
page
integer
required

Page number to retrieve

Required range: x >= 1
​
pagesize
integer
default:100

Number of results per page (max: 100)

Required range: 1 <= x <= 100
​
added_from
string<date>

Filter customers added from this date (YYYY-MM-dd format)

​
added_to
string<date>

Filter customers added until this date (YYYY-MM-dd format)

​
signedup
enum<string>

Filter by registration status

  • 0 = unregistered customers
  • 1 = registered customers
Available options:
0,
1
​
first_order_from
string<date>

Filter customers with first order from this date (YYYY-MM-dd format)

​
first_order_to
string<date>

Filter customers with first order until this date (YYYY-MM-dd format)

​
devices_unregistered_from
string<date>

Filter customers with most recent app uninstall from this date

​
devices_unregistered_to
string<date>

Filter customers with most recent app uninstall until this date

​
signup_deleted_from
string<date>

Filter customers with account deleted from this date (YYYY-MM-dd format)

​
signup_deleted_to
string<date>

Filter customers with account deleted until this date (YYYY-MM-dd format)

Response

Customer list response

​
success
boolean
required

Operation status:

  • false = Error
  • true = Success
​
error
string

Error code if the operation failed.

See Error codes for general error codes that may occur.

​
message
string

Textual error description if the operation failed

​
page
integer

Current page number

​
pagesize
integer

Maximum number of elements per page

​
total_count
integer

Total number of results

​
more
boolean

Whether there are additional results:

  • false = No more results
  • true = More results available
​
customers
object[]

Array of customer objects