Znode

GET accounts

Gets a list of accounts.

Request Information

» Expands

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

» Filters

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

» Sorting

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

» Paging

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

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

Sample:
	{
  "Accounts": [
    {
      "AccountId": 11521,
      "AccountProfileCode": null,
      "AccountType": {
        "AccountTypeId": 0,
        "AccountTypeName": "CUSTOMER"
      },
      "AccountTypeId": 0,
      "Addresses": [],
      "CompanyName": "Your Company",
      "CreateDate": "2013-04-29T10:49:32.657",
      "CreateUser": null,
      "ReferralCommissionType": null,
      "Custom1": null,
      "Custom2": null,
      "Custom3": null,
      "Description": "Site Administrator Account",
      "Email": "znodeadmin1@test.com",
      "EmailOptIn": true,
      "EnableCustomerPricing": false,
      "ExternalId": null,
      "GiftCardHistoryList": null,
      "IsActive": true,
      "Orders": [],
      "ParentAccountId": null,
      "ProfileId": 1,
      "Profiles": [],
      "ReferralAccountId": null,
      "ReferralCommission": null,
      "ReferralCommissionTypeId": null,
      "ReferralStatus": null,
      "Source": null,
      "SubAccountLimit": null,
      "TaxId": null,
      "UpdateDate": "2013-09-21T11:59:19.74",
      "UpdateUser": null,
      "User": null,
      "AddressModel": null,
      "UserId": "8086a820-d3f6-4763-ae07-ce84ab85e2e7",
      "WebServiceDownloadDate": null,
      "Website": null,
      "WishList": [],
      "BaseUrl": null,
      "IsUserInRole": false,
      "UserName": null,
      "RoleName": null,
      "ErrorCode": null,
      "FullName": null,
      "PhoneNumber": null,
      "FirstName": null,
      "LastName": null,
      "LoginName": null,
      "ExternalAccountNum": null,
      "StartDate": "0001-01-01T00:00:00",
      "EndDate": "0001-01-01T00:00:00",
      "PortalId": null,
      "UserType": null,
      "IsEmailSent": false
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}