Account

The Account object represents an individual account on the Marketplace platform.

This object contains the following attributes:

Field Name	Data Type	Description
id	string	The primary identifier for the account. Example: ACC-1671-0642
href	string	A relative reference to the object. Example: /v1/accounts/accounts/ACC-1671-0642
type	string	The type of the account. Allowed values: client, vendor, or operations.
status	string	The account's status on the platform. Allowed values: enabled, active, or disabled.
name	string	The name of the account. Example: Stark Industries
description	string	The account's description. Example: Our company account
externalId	string	External identifier - Customer Discount Group number. Example: WW-1001111
externalName	string	External identifier - Customer Discount Group name. Example: Stark Industries
serviceLevel	string	The service level offered to the account. Allowed values: essential, elite, or DSC.
address	object	The address of the company. Example: { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }
icon	string	The relative path to the account's logo. Example: /static/accounts/ACC-1671-0642/logo.png
website	string	The path to the company’s website. Example: https://www.example.com
technicalSupportEmail	string	The email address for technical support. Example: [email protected]
audit	object	A reference to the audit object. Allowed values: created, updated, disabled, enabled, or activated.
groups	object	A reference to the userGroup object.

Example response

SHORT FORM

{
  "id": "ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "[email protected]",
  "website": "https://example.com"
}

FULL EXAMPLE