| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\napi\\_version\n\n | \n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nsysparm\\_limit\n\n | \n\nMaximum number of records to return. For requests that exceed this number of records, use the **sysparm\\_offset** parameter to paginate record retrieval.\n\nIn the response, the boolean parameter **hasMore** is returned. It indicates whether there are more records to return that meet the filter criteria.\n\nData type: Number\n\nDefault: 10\n\n |
| \n\nsysparm\\_offset\n\n | \n\nStarting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks.\n\nFor example, the first time you call this endpoint, **sysparm\\_offset** is set to \"0\". To simply page through all available records, use `sysparm_offset=sysparm_offset+sysparm_limit`, until you reach the end of all records.\n\nDo not pass a negative number in the **sysparm\\_offset** parameter.\n\nData type: Number\n\nDefault: 0\n\n |
| \n\nsysparm\\_query\n\n | \n\nEncoded query used to filter the result set.For example:\n\n`sysparm_query=caller_id=javascript:gs.getUserID()^active=true`\n\nThe encoded query supports order by. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in **sysparm\\_query**. For example, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` filters all active records and orders the results in ascending order by number first, and then in descending order by category.\n\nIf part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. You can control this behavior using the property **glide.invalid\\_query.returns\\_no\\_rows**. Set this property to true to return no rows on an invalid query.\n\n**Note:** The **glide.invalid\\_query.returns\\_no\\_rows** property controls the behavior of all queries across the instance, such as in lists, scripts \\(GlideRecord.query\\(\\)\\), and web service APIs.\n\nData type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nParameter\n\n | \n\nDescription\n\n |
|---|---|
| \n\naccount\\_code\n\n | \n\nUnique combination of values that an application uses to identify budget forecasts and budget plans.Data type: String\n\nMaximum length: 255\n\n |
| \n\naccount\\_parent\n\n | \n\nSys\\_id of the parent account of this account. Located in the Account \\[customer\\_account\\] table.Data type: String\n\n |
| \n\naccount\\_path\n\n | \n\nPath from the parent to the child accounts in the account hierarchy.Data type: String\n\nMaximum length: 255\n\n |
| \n\nactive\\_escalation\n\n | \n\nSys\\_id of the active escalation associated with the account.Data type: String\n\nTable: Escalation \\[sn\\_customerservice\\_escalation\\]\n\n |
| \n\napple\\_icon\n\n | \n\nIcon for iPhone home page bookmarks.Data type: Image\n\n |
| \n\nbanner\\_image\n\n | \n\nBanner image that appears on the customer portal.Data type: Image\n\n |
| \n\nbanner\\_image\\_light\n\n | \n\nSmall banner image.Data type: Image\n\n |
| \n\nbanner\\_text\n\n | \n\nBanner text that appears on the customer portal.Data type: String\n\nMaximum length: 4,000\n\n |
| \n\ncity\n\n | \n\nCity in which the company that is associated with this account resides.Data type: String\n\nMaximum length: 50\n\n |
| \n\ncontact\n\n | \n\nSys\\_id of a contact record associated with this account.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\ncountry\n\n | \n\nCountry in which the company that is associated with this account resides.Data type: String\n\nMaximum length: 40\n\nDefault: USA\n\n |
| \n\ncustomer\n\n | \n\nFlag that indicates whether the account is a customer account, as opposed to a partner account.Possible values:\n\n- true: Customer account\n- false: Partner account\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\ndiscount\n\n | \n\nDiscount given to the account on purchases.Data type: Number\n\nMaximum length: 15\n\n |
| \n\nfax\\_phone\n\n | \n\nPrimary fax phone number for the company associated with this account.Data type: String\n\nMaximum length: 40\n\n |
| \n\nfiscal\\_year\n\n | \n\nFiscal year for the company associated with the account.Data type: String\n\n |
| \n\nlat\\_long\\_error\n\n | \n\nDifference in the actual location as compared to latitude and longitude information.Data type: String\n\nMaximum length: 1,000\n\n |
| \n\nlatitude\n\n | \n\nLatitude of the company associated with this account.Data type: Number \\(floating point number\\)\n\nMaximum length: 40\n\n |
| \n\nlongitude\n\n | \n\nLongitude of the company associated with this account.Data type: Number \\(floating point number\\)\n\nMaximum length: 40\n\n |
| \n\nmanufacturer\n\n | \n\nFlag that indicates whether the company associated with this account manufactures goods.Possible values:\n\n- true: Manufactures goods\n- false: Does not manufacture goods\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nmarket\\_cap\n\n | \n\nMarket value of the associated company's publicly traded stock shares.Data type: Number \\(currency\\)\n\nMaximum length: 20\n\n |
| \n\nname\n\n | \n\nName of the company associated with this account.Data type: String\n\nMaximum length: 80\n\n |
| \n\nnotes\n\n | \n\nAdditional information about the company.Data type: String\n\nMaximum length: 4,000\n\n |
| \n\nnum\\_employees\n\n | \n\nNumber of people employed by the company.Data type: Number \\(Integer\\)\n\nMaximum length: 40\n\n |
| \n\nnumber\n\n | \n\nNumber that identifies this account.Data type: String\n\nMaximum length: 40\n\n |
| \n\nparent\n\n | \n\nSys\\_id of the parent account of this account.Data type: String\n\nTable: Company \\[core\\_company\\]\n\n |
| \n\npartner\n\n | \n\nFlag that indicates whether the account is a partner account or a customer account.Possible values:\n\n- true: Partner account\n- false: Customer account\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nphone\n\n | \n\nPrimary phone number for the company.Data type: String\n\n |
| \n\nprimary\n\n | \n\nFlag that indicates whether this is a primary account.Possible values:\n\n- true: Primary account\n- false: Secondary account\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nprimary\\_contact\n\n | \n\nSys\\_id of the primary contact for the account.Data type: String\n\nTable: Contact \\[customer\\_contact\\]\n\n |
| \n\nprofits\n\n | \n\nProfit information entered for this account.Data type: Number \\(Currency\\)\n\nMaximum length: 40\n\n |
| \n\npublicly\\_traded\n\n | \n\nFlag that indicates whether the company associated with this account is publicly traded on the stock exchange.Possible values:\n\n- true: Publicly traded\n- false: Private company\n\nData type: Boolean\n\n |
| \n\nrank\\_tier\n\n | \n\nType of account.Possible values:\n\n- blacklist\n- other\n- strategic\n- tactical\n- valued\n\nData type: String\n\nMaximum length: 40\n\n |
| \n\nregistration\\_code\n\n | \n\nUnique code that customers use when requesting a login on the customer portal. This code provides a method for validating the customer on the company before granting access.Data type: String\n\nMaximum length: 40\n\n |
| \n\nrevenue\\_per\\_year\n\n | \n\nRevenue produced by the company associated with this account.Data type: Number \\(Currency\\)\n\nMaximum length: 20\n\n |
| \n\nstate\n\n | \n\nState in which the company resides.Data type: String\n\nMaximum length: 40\n\n |
| \n\nstock\\_price\n\n | \n\nPrice of the company stock.Data type: String\n\nMaximum length: 40\n\n |
| \n\nstock\\_symbol\n\n | \n\nStock symbol of the company.Data type: String\n\nMaximum length: 40\n\n |
| \n\nstreet\n\n | \n\nStreet address of the company.Data type: String\n\nMaximum length: 255\n\n |
| \n\nsys\\_class\\_name\n\n | \n\nTable that contains the associated account record.Data type: String\n\n |
| \n\nsys\\_created\\_by\n\n | \n\nUser that originally created the account.Data type: String\n\nMaximum length: 40\n\n |
| \n\nsys\\_created\\_on\n\n | \n\nDate and time that the account was originally created.Data type: String\n\n |
| \n\nsys\\_id\n\n | \n\nSys\\_id for the account record.Data type: String\n\n |
| \n\nsys\\_mod\\_count\n\n | \n\nNumber of times the account information has been updated.Data type: Number \\(Integer\\)\n\n |
| \n\nsys\\_updated\\_by\n\n | \n\nUser that last modified the account information.Data type: String\n\nMaximum length: 40\n\n |
| \n\nsys\\_updated\\_on\n\n | \n\nDate and time the account information was last updated.Data type: String\n\n |
| \n\ntheme\n\n | \n\nSys\\_id of the customer portal theme used by this account.Data type: String\n\nTable: Theme \\[sys\\_ui\\_theme\\]\n\n |
| \n\nvendor\n\n | \n\nFlag that indicates whether the company associated with this account is a vendor.Possible values:\n\n- true: Vendor\n- false: Not a vendor\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nvendor\\_manager\n\n | \n\nList of sys\\_ids of the vendor managers for the account.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\nvendor\\_type\n\n | \n\nList of sys\\_ids of the type of vendor such as, applications, hardware, services, or software.Data type: String\n\nTable: Vendor Type \\[vendor\\_type\\]\n\n |
| \n\nwebsite\n\n | \n\nURL of the website for the company.Data type: String\n\nMaximum length: 1,024\n\n |
| \n\nzip\n\n | \n\nZip code of the company.Data type: String\n\nMaximum length: 40\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\napi\\_version\n\n | \n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n |
| \n\nid\n\n | \n\nSys\\_id of the account to retrieve. Located in the Customer \\[customer\\_account\\] table.Data type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nStatus code\n\n | \n\nDescription\n\n |
|---|---|
| \n\n200\n\n | \n\nSuccessful. The request was successfully processed.\n\n |
| \n\n404\n\n | \n\nIndicates that the request is invalid.i89Possible cause:\n\n- Requested case doesn’t exist.\n- User doesn’t have access to the account record.\n\n |
| \n\nParameter\n\n | \n\nDescription\n\n |
|---|---|
| \n\naccount\\_code\n\n | \n\nUnique combination of values that an application uses to identify budget forecasts and budget plans.Data type: String\n\nMaximum length: 255\n\n |
| \n\naccount\\_parent\n\n | \n\nSys\\_id of the parent account of this account. Located in the Account \\[customer\\_account\\] table.Data type: String\n\n |
| \n\naccount\\_path\n\n | \n\nPath from the parent to the child accounts in the account hierarchy.Data type: String\n\nMaximum length: 255\n\n |
| \n\nactive\\_escalation\n\n | \n\nSys\\_id of the active escalation associated with the account.Data type: String\n\nTable: Escalation \\[sn\\_customerservice\\_escalation\\]\n\n |
| \n\napple\\_icon\n\n | \n\nIcon for iPhone home page bookmarks.Data type: Image\n\n |
| \n\nbanner\\_image\n\n | \n\nBanner image that appears on the customer portal.Data type: Image\n\n |
| \n\nbanner\\_image\\_light\n\n | \n\nSmall banner image.Data type: Image\n\n |
| \n\nbanner\\_text\n\n | \n\nBanner text that appears on the customer portal.Data type: String\n\nMaximum length: 4,000\n\n |
| \n\ncity\n\n | \n\nCity in which the company that is associated with this account resides.Data type: String\n\nMaximum length: 50\n\n |
| \n\ncontact\n\n | \n\nSys\\_id of a contact record associated with this account.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\ncountry\n\n | \n\nCountry in which the company that is associated with this account resides.Data type: String\n\nMaximum length: 40\n\nDefault: USA\n\n |
| \n\ncustomer\n\n | \n\nFlag that indicates whether the account is a customer account, as opposed to a partner account.Possible values:\n\n- true: Customer account\n- false: Partner account\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\ndiscount\n\n | \n\nDiscount given to the account on purchases.Data type: Number\n\nMaximum length: 15\n\n |
| \n\nfax\\_phone\n\n | \n\nPrimary fax phone number for the company associated with this account.Data type: String\n\nMaximum length: 40\n\n |
| \n\nfiscal\\_year\n\n | \n\nFiscal year for the company associated with the account.Data type: String\n\n |
| \n\nlat\\_long\\_error\n\n | \n\nDifference in the actual location as compared to latitude and longitude information.Data type: String\n\nMaximum length: 1,000\n\n |
| \n\nlatitude\n\n | \n\nLatitude of the company associated with this account.Data type: Number \\(floating point number\\)\n\nMaximum length: 40\n\n |
| \n\nlongitude\n\n | \n\nLongitude of the company associated with this account.Data type: Number \\(floating point number\\)\n\nMaximum length: 40\n\n |
| \n\nmanufacturer\n\n | \n\nFlag that indicates whether the company associated with this account manufactures goods.Possible values:\n\n- true: Manufactures goods\n- false: Does not manufacture goods\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nmarket\\_cap\n\n | \n\nMarket value of the associated company's publicly traded stock shares.Data type: Number \\(currency\\)\n\nMaximum length: 20\n\n |
| \n\nname\n\n | \n\nName of the company associated with this account.Data type: String\n\nMaximum length: 80\n\n |
| \n\nnotes\n\n | \n\nAdditional information about the company.Data type: String\n\nMaximum length: 4,000\n\n |
| \n\nnum\\_employees\n\n | \n\nNumber of people employed by the company.Data type: Number \\(Integer\\)\n\nMaximum length: 40\n\n |
| \n\nnumber\n\n | \n\nNumber that identifies this account.Data type: String\n\nMaximum length: 40\n\n |
| \n\nparent\n\n | \n\nSys\\_id of the parent account of this account.Data type: String\n\nTable: Company \\[core\\_company\\]\n\n |
| \n\npartner\n\n | \n\nFlag that indicates whether the account is a partner account or a customer account.Possible values:\n\n- true: Partner account\n- false: Customer account\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nphone\n\n | \n\nPrimary phone number for the company.Data type: String\n\n |
| \n\nprimary\n\n | \n\nFlag that indicates whether this is a primary account.Possible values:\n\n- true: Primary account\n- false: Secondary account\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nprimary\\_contact\n\n | \n\nSys\\_id of the primary contact for the account.Data type: String\n\nTable: Contact \\[customer\\_contact\\]\n\n |
| \n\nprofits\n\n | \n\nProfit information entered for this account.Data type: Number \\(Currency\\)\n\nMaximum length: 40\n\n |
| \n\npublicly\\_traded\n\n | \n\nFlag that indicates whether the company associated with this account is publicly traded on the stock exchange.Possible values:\n\n- true: Publicly traded\n- false: Private company\n\nData type: Boolean\n\n |
| \n\nrank\\_tier\n\n | \n\nType of account.Possible values:\n\n- blacklist\n- other\n- strategic\n- tactical\n- valued\n\nData type: String\n\nMaximum length: 40\n\n |
| \n\nregistration\\_code\n\n | \n\nUnique code that customers use when requesting a login on the customer portal. This code provides a method for validating the customer on the company before granting access.Data type: String\n\nMaximum length: 40\n\n |
| \n\nrevenue\\_per\\_year\n\n | \n\nRevenue produced by the company associated with this account.Data type: Number \\(Currency\\)\n\nMaximum length: 20\n\n |
| \n\nstate\n\n | \n\nState in which the company resides.Data type: String\n\nMaximum length: 40\n\n |
| \n\nstock\\_price\n\n | \n\nPrice of the company stock.Data type: String\n\nMaximum length: 40\n\n |
| \n\nstock\\_symbol\n\n | \n\nStock symbol of the company.Data type: String\n\nMaximum length: 40\n\n |
| \n\nstreet\n\n | \n\nStreet address of the company.Data type: String\n\nMaximum length: 255\n\n |
| \n\nsys\\_class\\_name\n\n | \n\nTable that contains the associated account record.Data type: String\n\n |
| \n\nsys\\_created\\_by\n\n | \n\nUser that originally created the account.Data type: String\n\nMaximum length: 40\n\n |
| \n\nsys\\_created\\_on\n\n | \n\nDate and time that the account was originally created.Data type: String\n\n |
| \n\nsys\\_id\n\n | \n\nSys\\_id for the account record.Data type: String\n\n |
| \n\nsys\\_mod\\_count\n\n | \n\nNumber of times the account information has been updated.Data type: Number \\(Integer\\)\n\n |
| \n\nsys\\_updated\\_by\n\n | \n\nUser that last modified the account information.Data type: String\n\nMaximum length: 40\n\n |
| \n\nsys\\_updated\\_on\n\n | \n\nDate and time the account information was last updated.Data type: String\n\n |
| \n\ntheme\n\n | \n\nSys\\_id of the customer portal theme used by this account.Data type: String\n\nTable: Theme \\[sys\\_ui\\_theme\\]\n\n |
| \n\nvendor\n\n | \n\nFlag that indicates whether the company associated with this account is a vendor.Possible values:\n\n- true: Vendor\n- false: Not a vendor\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nvendor\\_manager\n\n | \n\nList of sys\\_ids of the vendor managers for the account.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\nvendor\\_type\n\n | \n\nList of sys\\_ids of the type of vendor such as, applications, hardware, services, or software.Data type: String\n\nTable: Vendor Type \\[vendor\\_type\\]\n\n |
| \n\nwebsite\n\n | \n\nURL of the website for the company.Data type: String\n\nMaximum length: 1,024\n\n |
| \n\nzip\n\n | \n\nZip code of the company.Data type: String\n\nMaximum length: 40\n\n |