Get Customer List

Nothing Found

Get Customer List

Endpoint to request customers by division

Securityapi_key

Request

path Parameters

divisionID

required

string

Division Identifier.

query Parameters

ci	string Customer Identifier
da	string Date created after
db	string Date created before
em	string Email
nm	string Name
pl	string Page Length
pn	string Page number
ia	boolean Is Active

Responses

200

401

Invalid API key/MID.

403

Forbidden from performing this action.

404

500

get/divisions/{divisionID}/customers/query

Response samples

application/json

{"customers": [{"name": "Test Customer",
"email": "[email protected]",
"cards": [{"lastFourDigits": "string",
"token": "string",
"holder": "string",
"expiryYear": "string",
"expiryMonth": "string",
"type": "visa",
"isActive": true
}
],
"phoneNumber": 61431306461,
"postcode": 2000,
"addressNumber": "12 Kings Road",
"addressLineOne": "Sydney CBD",
"addressLineTwo": "string",
"state": "NSW",
"city": "Sydney",
"country": "Australia",
"isActive": false
}
],
"meta": {"currentPage": 0,
"itemsPerPage": 0,
"totalItems": 0,
"itemCount": 0,
"totalPages": 0
}
}