REST API - Account Information

Version 2

    The REST API supports create, retrieve, update and delete operations for accounts.

     

    Accessing Accounts

    • GET  /data/account/{id}?depth={depth}

     

    Response

    The response for this call looks as follows :

     

    {
      "type": "Account",
      "id": "2",
      "createdAt": "1297278692",
      "depth": "complete",
      "description": "",
      "name": "Eloqua Corp.",
      "updatedAt": "1297278692",
      "address1": "1921 Gallows Road",
      "address2": "",
      "address3": "",
      "businessPhone": "",
      "city": "Vienna",
      "country": "USA",
      "fieldValues": [
        
      ],
      "postalCode": "",
      "province": ""
    }
    

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"Account"
    address1string
    address2string
    address3string
    businessPhonestring
    citystring
    countrystring
    fieldValuesList of FieldValueA list of custom fields for the account
    postalCodestring
    provincestring
    accessedAtintegerDateRequirement
    createdAtintegerReadOnlyDateRequirement
    createdByintegerReadOnlyIdRequirement
    currentStatusString
    depthRequestDepthEnumRequirement
    descriptionstring
    folderIdintegerIdRequirement
    idintegerThe unique identifier of the accountIdRequirement
    namestring
    permissionsInstance
    Permissions
    EnumRequirement
    updatedAtintegerReadOnlyDateRequirement
    updatedByintegerReadOnlyIdRequirement 

     

    Related Operations

    • POST :  /data/account
    • PUT :  /data/account/{id}
    • DELETE :  /data/account/{id}
    • GET (list) :  /data/accounts?depth={depth}&search={searchTerm}&page={page}&count={count}