GET v1/Customers?FirstName={FirstName}&LastName={LastName}&CommercialName={CommercialName}&CustomerId={CustomerId}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}
Retrieves customers satistfying the filter criteria.
REQUEST INFORMATION
URI PARAMETERS
Name | Description | Type | Additional information |
---|---|---|---|
FirstName | string | Max length: 30 | |
LastName | string | Max length: 30 | |
CommercialName | string | Max length: 50 | |
CustomerId | string | None. | |
Limit | Maximum number of records to return | integer | Range: inclusive between 1 and 2147483647 |
Offset | Number of records to skip during search, useful for pagination | integer | Range: inclusive between 0 and 2147483647 |
Total | Flag to indicate if the total number of records matching the search should be computed. Default: False. WARNING: Setting to True will considerably slow down search performance when searching large datasets. | boolean | None. |
SortDirection | Direction of sort: Ascending or Descending | SortDirection | None |
Sort | Comma separated list of field names to sort by | string | None |
Expand | Comma separated list of expansions to include in results | string | None |
BODY PARAMETERS
None.
RESPONSE INFORMATION
RESOURCE DESCRIPTION
List of customers
Name | Description | Type | Additional information |
---|---|---|---|
Limit | Echoed limit of request | integer | None. |
Offset | Echoed offset of request | boolean | None. |
Total | Total records matching search, if requested | integer | None. |
Data | List of records matching the search | Collection of CustomerOutboundDTO | None. |
RESPONSE FORMATS
APPLICATION/JSON, TEXT/JSON