Reads the customers.list procedure, the same operation the Fortune OS app performs. The credential's live venue permissions bound it.

post/api/public/v1/customers/list

Request

  • Base URL: https://app.fortuneos.ai
  • URL: https://app.fortuneos.ai/api/public/v1/customers/list
  • Auth: none declared

Request body

organizationIdstring required
querystring
pageinteger
segment'contactOnly' | 'new' | 'oneTime' | 'active' | 'atRisk' | 'lost'
badge'regular' | 'vip'
timeZonestring required
sort'created' | 'totalSpent' | 'visits' | 'lastVisit'
direction'asc' | 'desc'
createdFromstring date
createdTostring date
source'manual' | 'import' | 'pos'
birthdayFromstring
birthdayTostring
orderedFromstring date
orderedTostring date
firstOrderFromstring date
firstOrderTostring date
lastOrderFromstring date
lastOrderTostring date
minOrdersinteger
maxOrdersinteger
minSpentCentsinteger
maxSpentCentsinteger
categoryIdstring
catalogItemIdstring
locationIdstring

Response

OK

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.