Back to APIs

GET data/customers

Gets customers from your authorised venue

Request Information

data/customers?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&pageSize={pageSize}

URI Parameters

NameDescriptionTypeAdditional information
startDate

Search start date, based on customer modified date

date

Accepted format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss

endDate

Search end date, based on customer modified date

date

Accepted format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss

pageNumber

Page number

integer

Optional

Default value is 1

pageSize

Number of customer records returned

integer

Optional

Default value is 100

Response Information

Resource Description

PageOfCustomer
NameDescriptionTypeAdditional information
CurrentPage

integer

None.

TotalPages

integer

None.

TotalItems

integer

None.

ItemsPerPage

integer

None.

Items

Collection of Customer

None.

Response Formats

application/json

Sample:

Sample not available.