GET accountcompanies

No documentation available.

Request Information

» Expands

Name	Description	Usage
accountType	This will retrieve the related account type.	GET accountcompanies?expand=accounttype
addresses	This will retrieve the related list of addresses.	GET accountcompanies?expand=addresses
orders	This will retrieve the related list of orders.	GET accountcompanies?expand=orders
profiles	This will retrieve the related list of profiles.	GET accountcompanies?expand=profiles
wishList	This will retrieve the related list of wish lists.	GET accountcompanies?expand=wishlist

» Filters

Name	Description	Usage
accountId	This will filter the request by account ID.	GET accountcompanies?filter=accountid~{operator}~{value}
accountTypeId	This will filter the request by account type ID.	GET accountcompanies?filter=accounttypeid~{operator}~{value}
companyName	This will filter the request by company name.	GET accountcompanies?filter=companyname~{operator}~{value}
email	This will filter the request by email.	GET accountcompanies?filter=email~{operator}~{value}
emailOptIn	This will filter the request by the email opt in flag.	GET accountcompanies?filter=emailoptin~{operator}~{value}
enableCustomerPricing	This will filter the request by the enable customer pricing flag.	GET accountcompanies?filter=enablecustomerpricing~{operator}~{value}
externalId	This will filter the request by external ID.	GET accountcompanies?filter=externalid~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET accountcompanies?filter=isactive~{operator}~{value}
number	This will filter the request by number.	GET accountcompanies?filter=number~{operator}~{value}
parentAccountId	This will filter the request by parent account ID.	GET accountcompanies?filter=parentaccountid~{operator}~{value}
profileId	This will filter the request by profile ID.	GET accountcompanies?filter=profileid~{operator}~{value}
userId	This will filter the request by user ID.	GET accountcompanies?filter=userid~{operator}~{value}

» Sorting

Name	Description	Usage
accountId	This will sort the response by account ID.	GET accountcompanies?sort=accountid
companyName	This will sort the response by company name.	GET accountcompanies?sort=companyname
createDate	This will sort the response by create date.	GET accountcompanies?sort=createdate

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET accountcompanies?page=index~{value}
size	The size of the page when retrieving paged results.	GET accountcompanies?page=size~{value}