Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# List Customers Response
Defines the fields that are included in the response body of
a request to the `ListCustomers` endpoint.
Either `errors` or `customers` is present in a given response (never both).
## Structure
`ListCustomersResponse`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `errors` | [`?(Error[])`](/doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
| `customers` | [`?(Customer[])`](/doc/models/customer.md) | Optional | An array of `Customer` objects that match the provided query. | getCustomers(): ?array | setCustomers(?array customers): void |
| `cursor` | `?string` | Optional | A pagination cursor to retrieve the next set of results for the<br>original query. A cursor is only present if the request succeeded and additional results<br>are available.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
## Example (as JSON)
```json
{
"customers": [
{
"address": {
"address_line_1": "500 Electric Ave",
"address_line_2": "Suite 600",
"administrative_district_level_1": "NY",
"country": "US",
"locality": "New York",
"postal_code": "10003"
},
"created_at": "2016-03-23T20:21:54.859Z",
"creation_source": "THIRD_PARTY",
"email_address": "Amelia.Earhart@example.com",
"family_name": "Earhart",
"given_name": "Amelia",
"group_ids": [
"545AXB44B4XXWMVQ4W8SBT3HHF"
],
"id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
"note": "a customer",
"phone_number": "1-212-555-4240",
"preferences": {
"email_unsubscribed": false
},
"reference_id": "YOUR_REFERENCE_ID",
"segment_ids": [
"1KB9JE5EGJXCW.REACHABLE"
],
"updated_at": "2016-03-23T20:21:55Z",
"version": 1
}
]
}
```