Skip to main content

Get Account by Id

Get account details by metallic account id.

Path Variables

FieldDescriptionTypeNotes
accountIdAccount metallic idUUID

Response Body

FieldDescriptionTypeNotes
idAccount metallic idUUID
statusAccount statusString Enum - Account Status EnumerationSee - Account Status Enumeration
insertTsAccount created timeTimestamp
updateTsAccount last updated timeTimestamp
externalIdAccount id in Partner systemString / UUIDThis is the same as new account input in fulfillment request.
nameAccount nameString
websiteAccount websiteString
provisionCountryThe country that account is provisionedString
contactsAccount contactsContact Objects ArraySee - Contact Object
servicesAccount currently subscribed servicesService Objects arraySee - Service Object
deactivatedOptionsDeactivate OptionsDeactivate Options ObjectPresent only for deactivated accounts. See - Deactivate Options Object
typeAccount typeSting Enumeration Allowed Values: POC / Internal / ProductionThis is for MSP accounts only
Service Object
FieldDescriptionTypeNotes
skuService skuString
Deactivate Options Object
FieldDescriptionTypeNotes
disableLoginLogin disabled when set to trueBoolean
disableBackupBackup disabled when set to trueBoolean
disableRestoreRestore disabled when set to trueBoolean
Contact Object
FieldDescriptionTypeNotes
typeContact typeString Enum Allowed Values: adminCurrently only one contact per account is accepted and contact type is 'admin'.
emailContact emailString.
firstNameContact firstnameString
lastNameContact lastnameString
addressContact addressAddress ObjectSee - Address Object
phoneContact phone numberString
Address Object
FieldDescriptionTypeNotes
addressLine1Address line 1String
addressLine2Address line 2String
cityAddress cityString
stateAddress stateString
countryAddress countryString
postalCodeAddress postal codeString
Path Parameters
  • accountId string required

    Account metallic id

Responses

OK


Schema
    Loading...