List Accounts

/accounts

A list of all accounts within the user's assigned team.

Get Accounts [GET]

Get a list of accounts within the user's assigned teams.

Authorization: Admin, Web, Mobile, Portal

Parameters

  • includeLocations = false (optional, boolean, includeLocations=true) ... Whether to include the account's locations.
  • includeTeamIds = false (optional, boolean, includeTeamIds=true) ... Whether to include the account's associated team ids.
  • includeOpenFoldersCount = false (optional, boolean, includeOpenFoldersCount=true) ... Whether to include the key for the number of open folders in the account.
  • includeStatusCount = false (optional, boolean, includeStatusCount=true) ... Whether to include the key for the number of accounts within each status within the meta-data (Active and Inactive).
  • rowStatus (optional, oData, rowStatus eq 1) ... Filter list of accounts by given status.
  • id (optional, oData, id eq 786) ... Filter list of accounts by given id.
  • unsassigned (optional, oData, unassigned eq true) ... Filter list of accounts to only display accounts that have no assigned teams.
  • teamIds (optional, list, teamIds[]=56) ... Filter list of accounts to only display accounts assigned to listed teams.
  • createdAt (optional, oData, createdAt gt datetime'2014-03-10T14:54:00') ... Filter list of accounts created after given date.
  • createdBy (optional, oData, createdBy eq '8891') ... Filter list of accounts by the id of the user who created the account.
  • nameNum (optional, oData) ... Filter list of accounts by given name or num.
  • city (optional, oData) ... Filter list of accounts by city.
  • state (optional, oData) ... Filter list of accounts by state.

Response 200

Body
  {
        "page": 1,
        "pages": 2,
        "count": 52,
        "items": [
          {
            "id": 9082,
            "num": "SP9081",
            "name": "Springfield Nuclear Plant",
            "address": "123 Elm Street",
            "city": "Springfield",
            "state": "Oregan",
            "zip": "80982",
            "country": "US",
            "rowStatus": 1,
            "createdBy": "290",
            "createdAt": "2015-05-19T16:37:19.827Z",
            "modifiedAt": "2015-05-19T16:37:19.827Z",
            "reference1Value": "ref1value",
            "reference2Value": "ref2value",
            "reference3Value": "",
            "nameNum": "Springfield Nuclear Plant:SP9081",
            "guid": "19766890-ead8-496a-bf5e-29ab1f1072fe"
          }
        ]
   }

Still need help? Contact Us Contact Us