Get Account by Id

Get account details by metallic account id.

Path Variables

Field	Description	Type	Notes
accountId	Account metallic id	UUID

Response Body

Field	Description	Type	Notes
id	Account metallic id	UUID
status	Account status	String Enum - Account Status Enumeration	See - Account Status Enumeration
insertTs	Account created time	Timestamp
updateTs	Account last updated time	Timestamp
externalId	Account id in Partner system	String / UUID	This is the same as new account input in fulfillment request.
name	Account name	String
website	Account website	String
provisionCountry	The country that account is provisioned	String
contacts	Account contacts	Contact Objects Array	See - Contact Object
services	Account currently subscribed services	Service Objects array	See - Service Object
deactivatedOptions	Deactivate Options	Deactivate Options Object	Present only for deactivated accounts. See - Deactivate Options Object
type	Account type	Sting Enumeration Allowed Values: POC / Internal / Production	This is for MSP accounts only

Service Object

Field	Description	Type	Notes
sku	Service sku	String
quantity	Purchased quantity	Integer
orderDate	Order date	Date
serviceType	Service type	String	Possible values: trial / paid
trialEndDate	Trial end date	Date	Only returned if service is in trial

Deactivate Options Object

Field	Description	Type	Notes
disableLogin	Login disabled when set to true	Boolean
disableBackup	Backup disabled when set to true	Boolean
disableRestore	Restore disabled when set to true	Boolean

Contact Object

Field	Description	Type	Notes
type	Contact type	String Enum Allowed Values: admin	Currently only one contact per account is accepted and contact type is 'admin'.
email	Contact email	String	.
firstName	Contact firstname	String
lastName	Contact lastname	String
address	Contact address	Address Object	See - Address Object
phone	Contact phone number	String

Address Object

Field	Description	Type	Notes
addressLine1	Address line 1	String
addressLine2	Address line 2	String
city	Address city	String
state	Address state	String
country	Address country	String
postalCode	Address postal code	String

Path Parameters

• accountId string required

  Account metallic id

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Get Account by Id - Success

---

Schema

• data object

  id string

  status string

  insertTs string

  updateTs string

  externalId string

  name string

  website string

  provisionCountry string

  contacts object[]

  type string

  email string

  firstName string

  lastName string

  phone string

  address object

  addressLine1 string

  addressLine2 string

  city string

  state string

  country string

  postalCode string

  services object[]

  sku string

  type string

{
  "data": {
    "id": "7194af6f-1285-4295-94aa-ceed7ea2d792",
    "status": "active",
    "insertTs": "2021-06-07T21:16:48",
    "updateTs": "2021-06-07T21:16:48",
    "externalId": "XSP1234",
    "name": "Acme ltd",
    "website": "www.acme.com",
    "provisionCountry": "United States",
    "contacts": [
      {
        "type": "admin",
        "email": "tada@acme.com",
        "firstName": "Tada",
        "lastName": "Wu",
        "phone": "+1 302 000 2020",
        "address": {
          "addressLine1": "1 Ave",
          "addressLine2": "Suite 204",
          "city": "Sunnyvale",
          "state": "California",
          "country": "United States",
          "postalCode": "94086"
        }
      }
    ],
    "services": [
      {
        "sku": "MTL-O365-USRO-NC"
      },
      {
        "sku": "MTL-EP-USRO-NC"
      }
    ],
    "type": "Production"
  }
}

{
  "data": {
    "id": "7194af6f-1285-4295-94aa-ceed7ea2d792",
    "status": "active",
    "insertTs": "2021-06-07T21:16:48",
    "updateTs": "2021-06-07T21:16:48",
    "externalId": "XSP1234",
    "name": "Acme ltd",
    "website": "www.acme.com",
    "provisionCountry": "United States",
    "contacts": [
      {
        "type": "admin",
        "email": "tada@acme.com",
        "firstName": "Tada",
        "lastName": "Wu",
        "phone": "+1 302 000 2020",
        "address": {
          "addressLine1": "1 Ave",
          "addressLine2": "Suite 204",
          "city": "Sunnyvale",
          "state": "California",
          "country": "United States",
          "postalCode": "94086"
        }
      }
    ],
    "services": [
      {
        "sku": "MTSP-FOB-FT",
        "quantity": 0,
        "orderDate": "2025-03-05",
        "paymentOption": "pay_as_you_go",
        "trialEndDate": "2025-03-19",
        "serviceType": "trial"
      },
      {
        "sku": "MTSP-BKRC-VM",
        "quantity": 0,
        "orderDate": "2025-03-05",
        "paymentOption": "pay_as_you_go",
        "serviceType": "paid"
      }
    ],
    "type": "Production"
  }
}

Loading...