GET v1/Customers?FirstName={FirstName}&LastName={LastName}&CommercialName={CommercialName}&CustomerId={CustomerId}&ExternalCustomerNumber={ExternalCustomerNumber}&Limit={Limit}&Offset={Offset}&Total={Total}&SortDirection={SortDirection}&Sort={Sort}&Expand={Expand}
Customer Search
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
FirstName | string |
String length: inclusive between 0 and 30 |
|
LastName | string |
String length: inclusive between 0 and 30 |
|
CommercialName | string |
String length: inclusive between 0 and 500 |
|
CustomerId | string |
None. |
|
ExternalCustomerNumber | string |
String length: inclusive between 0 and 255 |
|
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
CustomerListResponseName | Description | Type | Additional information |
---|---|---|---|
Limit |
Echoed limit of request |
integer |
None. |
Offset |
Echoed offset of request |
integer |
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
{ "Limit": 1, "Offset": 1, "Total": 1, "Data": [ { "FirstName": "sample string 1", "Id": 2, "LastName": "sample string 3", "CommercialName": "sample string 4", "Type": "Unknown", "LegalStatus": "Unknown", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "MobilePhone": "sample string 5", "HomePhone": "sample string 6", "WorkPhone": "sample string 7", "SecondaryMobilePhone": "sample string 8", "FaxNumber": "sample string 9", "Email": "sample string 10", "Quotes": [ { "AgencyId": 1, "AgentId": 1, "SubagencyId": 1, "DivisionOrganizationId": 1, "BillPlanId": 1, "RenewalBillPlanId": 1, "CustomerId": 1, "CompleteQuote": true, "EffectiveDate": "2024-04-28T06:31:53.6669409-10:00", "ExpirationDate": "2024-04-28T06:31:53.6669409-10:00", "QuoteTerm": "Unknown", "LineOfBusiness": "sample string 1", "PolicyNumber": "sample string 2", "Premium": 1.0, "PrimaryNamedInsured": { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, "QuoteNumber": "sample string 3", "RateGuaranteeDate": "2024-04-28T06:31:53.6679411-10:00", "RatingTaxa": "sample string 4", "State": "sample string 5", "Country": "sample string 6", "UnderwritingCompanyId": 7, "UniversalAccountId": 8, "AgencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "SubagencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AgentCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AdditionalPayees": [ { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 }, { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 } ], "CustomQuoteNumber": "sample string 9", "QuoteName": "sample string 10", "UnderwritingResults": [ { "RuleCode": "sample string 1", "Message": "sample string 2" }, { "RuleCode": "sample string 1", "Message": "sample string 2" } ], "Id": 11 }, { "AgencyId": 1, "AgentId": 1, "SubagencyId": 1, "DivisionOrganizationId": 1, "BillPlanId": 1, "RenewalBillPlanId": 1, "CustomerId": 1, "CompleteQuote": true, "EffectiveDate": "2024-04-28T06:31:53.6669409-10:00", "ExpirationDate": "2024-04-28T06:31:53.6669409-10:00", "QuoteTerm": "Unknown", "LineOfBusiness": "sample string 1", "PolicyNumber": "sample string 2", "Premium": 1.0, "PrimaryNamedInsured": { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, "QuoteNumber": "sample string 3", "RateGuaranteeDate": "2024-04-28T06:31:53.6679411-10:00", "RatingTaxa": "sample string 4", "State": "sample string 5", "Country": "sample string 6", "UnderwritingCompanyId": 7, "UniversalAccountId": 8, "AgencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "SubagencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AgentCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AdditionalPayees": [ { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 }, { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 } ], "CustomQuoteNumber": "sample string 9", "QuoteName": "sample string 10", "UnderwritingResults": [ { "RuleCode": "sample string 1", "Message": "sample string 2" }, { "RuleCode": "sample string 1", "Message": "sample string 2" } ], "Id": 11 } ], "BirthDate": "2024-04-28T06:31:53.668941-10:00", "CitizenCountryId": 1, "BirthCountryId": 1, "Fein": "sample string 11", "YearStarted": 1, "EstablishCountryId": 1, "ExternalCustomerNumber": "sample string 12", "Attributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "FirstName": "sample string 1", "Id": 2, "LastName": "sample string 3", "CommercialName": "sample string 4", "Type": "Unknown", "LegalStatus": "Unknown", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "MobilePhone": "sample string 5", "HomePhone": "sample string 6", "WorkPhone": "sample string 7", "SecondaryMobilePhone": "sample string 8", "FaxNumber": "sample string 9", "Email": "sample string 10", "Quotes": [ { "AgencyId": 1, "AgentId": 1, "SubagencyId": 1, "DivisionOrganizationId": 1, "BillPlanId": 1, "RenewalBillPlanId": 1, "CustomerId": 1, "CompleteQuote": true, "EffectiveDate": "2024-04-28T06:31:53.6669409-10:00", "ExpirationDate": "2024-04-28T06:31:53.6669409-10:00", "QuoteTerm": "Unknown", "LineOfBusiness": "sample string 1", "PolicyNumber": "sample string 2", "Premium": 1.0, "PrimaryNamedInsured": { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, "QuoteNumber": "sample string 3", "RateGuaranteeDate": "2024-04-28T06:31:53.6679411-10:00", "RatingTaxa": "sample string 4", "State": "sample string 5", "Country": "sample string 6", "UnderwritingCompanyId": 7, "UniversalAccountId": 8, "AgencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "SubagencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AgentCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AdditionalPayees": [ { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 }, { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 } ], "CustomQuoteNumber": "sample string 9", "QuoteName": "sample string 10", "UnderwritingResults": [ { "RuleCode": "sample string 1", "Message": "sample string 2" }, { "RuleCode": "sample string 1", "Message": "sample string 2" } ], "Id": 11 }, { "AgencyId": 1, "AgentId": 1, "SubagencyId": 1, "DivisionOrganizationId": 1, "BillPlanId": 1, "RenewalBillPlanId": 1, "CustomerId": 1, "CompleteQuote": true, "EffectiveDate": "2024-04-28T06:31:53.6669409-10:00", "ExpirationDate": "2024-04-28T06:31:53.6669409-10:00", "QuoteTerm": "Unknown", "LineOfBusiness": "sample string 1", "PolicyNumber": "sample string 2", "Premium": 1.0, "PrimaryNamedInsured": { "FirstName": "sample string 1", "LastName": "sample string 2", "CommercialName": "sample string 3", "EmailAddress": "sample string 4", "HomePhone": "sample string 5", "MobilePhone": "sample string 6", "RiskAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "RiskAddressIsMailingAddress": true, "MailingAddress": { "Type": "Unknown", "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "County": "sample string 5", "Country": "sample string 6", "Zipcode1": "sample string 7", "Zipcode2": "sample string 8", "Id": 9 }, "Type": "Unknown", "Id": 7 }, "QuoteNumber": "sample string 3", "RateGuaranteeDate": "2024-04-28T06:31:53.6679411-10:00", "RatingTaxa": "sample string 4", "State": "sample string 5", "Country": "sample string 6", "UnderwritingCompanyId": 7, "UniversalAccountId": 8, "AgencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "SubagencyCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AgentCommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "AdditionalPayees": [ { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 }, { "Type": "Unknown", "CommissionOverride": { "Type": "Unknown", "Rate": 1.0, "OverrideType": "Unknown", "OverrideRate": 1.0, "CommissionOverride": true, "Id": 2 }, "Id": 1 } ], "CustomQuoteNumber": "sample string 9", "QuoteName": "sample string 10", "UnderwritingResults": [ { "RuleCode": "sample string 1", "Message": "sample string 2" }, { "RuleCode": "sample string 1", "Message": "sample string 2" } ], "Id": 11 } ], "BirthDate": "2024-04-28T06:31:53.668941-10:00", "CitizenCountryId": 1, "BirthCountryId": 1, "Fein": "sample string 11", "YearStarted": 1, "EstablishCountryId": 1, "ExternalCustomerNumber": "sample string 12", "Attributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ] }
application/xml
Sample not available.
text/xml
Sample not available.