Get Customers
GET {{baseUrl}}/aggregation/v1/customers?username=&type=&search=&start=1&limit=25
Find all customers enrolled by the current partner, where the search text is found in the customer's username or any combination of firstName and lastName fields. If no search text is provided, all customers will be returned.
Supported regions: 
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
username | null | Username for exact match (will return 0 or 1 record) | |
type | null | "testing" or "active" to return only customers of that type, or leave empty to return all customers. | |
search | null | The text you wish to match. Leave this empty if you wish to return all customers. Must be URL-encoded (see also: How do you handle Spaces in Queries?). | |
start | number | Index of the page of results to return | |
limit | number | Maximum number of results per page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
App-Key | string | ||
Finicity-App-Token | string |
RESPONSES
status: OK
{"found":200,"displaying":2,"moreAvailable":true,"customers":[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"username":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"createdDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"firstName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastModifiedDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"addressLine1":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"username":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"createdDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"firstName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastModifiedDate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"addressLine1":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}