Customers

Operations related to customers

Get customers

get

Retrieves information about all of your customers. Use the page parameter to paginate results.

Sorting: Use the sort parameter to order the returned customers.

Available criteria:

• revenue – orders customers by total revenue.

Time filtering: Use date_filter to select customers within a specific time range. Timestamps must be expressed in your store’s timezone.

Format: [start_timestamp, end_timestamp]

Example: [1759333917,1761234717] selects customers from October 1st to October 23rd (Europe/Paris timezone)

Authorization:

• Requires a valid JWT Bearer token.

• The token must include the permission: read-customers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

The page number to retrieve.

Default: 1

max_pageintegerOptional

The maximum number of elements per page. This number must be between 5-50.

Default: 50

sortstringOptional

Defines the sorting criteria used to order the returned customers. By default there's no sorting.

date_filterstringOptional

Filter customers by a specific time interval. Provide timestamps in your store’s timezone.

Format: [start_timestamp, end_timestamp]

Example: [1759333917000,1761234717] selects customers from October 1st to October 23rd (Europe/Paris timezone)

By default this filter is omitted.

Responses

200

Successful operation

application/json

customer_countnumberOptionalExample: 410

currencystringOptional

The store's currency. All total_revenue values represent the amount spent by each customer, converted to the store currency.

Example: EUR

403

Didn't provide a valid Tip4Serv API Key

application/json

500

Internal Server Error

application/json

get/store/customers

GET /v1/store/customers HTTP/1.1
Host: api.tip4serv.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "customers": [
    {
      "user_id": 19674,
      "username": "Duster",
      "discord_id": "274785054121525248",
      "steam_id": "76561198380145423",
      "player_id": "C84A567",
      "minecraft_uuid": "87ac351717f74762bfcaeff0ddd1a9bd",
      "total_revenue": 140.43,
      "payments": 5,
      "avatar": "https://mc-heads.net/head/1eb1416dbf0342728a8301118367cb0b",
      "loyalty_points": 360
    }
  ],
  "customer_count": 410,
  "currency": "EUR"
}