Customer Data List

get

https://api.sitevibes.com/v1/loyalty/customers

Returns paginated customers data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

app_id

string

required

Identifier used to differentiate different applications api is used in

page

integer

Defaults to 1

The page of paginated data that will be returned

limit

integer

1 to 100

Defaults to 10

The maximum number of objects that may be returned

order_by

string

enum

Defaults to newest

Sorting logic

newest - order by Newest customers
oldest - order by Oldest customers

Allowed:

string

Filter by customer email (you can add multiple values by separating them with a comma)

cid

string

Filter by customer cid (you can add multiple values by separating them with a comma)

external_customer_id

string

Filter by profile external_customer_id (you can add multiple values by separating them with a comma)

phone

string

Filter by customer phone (you can add multiple values by separating them with a comma)

identifier

string

Filter by customer identifier (you can add multiple values by separating them with a comma)

updated_since

string

Return only customer last update after specific date (ISO 8601 timestamp)

has_points

boolean

Filter by whether the customer has a points balance. Use true to return only customers with points > 0, or false to return only customers with points <= 0.

Responses

200Success

401Access token is missing or invalid

422Some required fields are missing or invalid