Get Partner By Id

Select

SaaS

Get Partner By Id

Path Parameters

• partnerId string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• data object

  name string

  Partner Name

  externalId string

  Partner ID in MSP system

  website string

  Partner website

  contacts object[]

  Partner contacts

  type string

  Default value: primary

  Contact type.We currently support "primary" type only.

  email string

  Contact email. It needs to be a valid email and unique in Metallic.

  firstName string

  Contact first name

  lastName string

  Contact last name

  address object

  Contact address

  addressLine1 string

  Street address

  addressLine2 string

  Street address continued

  city string

  City

  state string

  This field is required when country is United States, otherwise is optional. If provided, it must be ISO standard code or name.

  country string

  Country

  postalCode string

  Postal Code

  workloadAccess boolean

  Access to manage accounts

{
  "data": {
    "name": "string",
    "externalId": "string",
    "website": "string",
    "contacts": [
      {
        "type": "primary",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postalCode": "string"
        }
      }
    ],
    "workloadAccess": true
  }
}

{
  "data": {
    "id": "2dde73c6-10c7-4299-924b-c81c60e33e14",
    "insertTs": "2022-06-21T17:49:29",
    "updateTs": "2022-06-21T17:49:29",
    "name": "Partner 1",
    "externalId": "msp1-partner-1",
    "website": "partner1.com",
    "status": "active",
    "contacts": [
      {
        "email": "admin@partner1.com",
        "firstName": "Admin",
        "lastName": "User",
        "address": {
          "addressLine1": "1 Rd",
          "city": "Santa Clara",
          "state": "California",
          "country": "United States",
          "postalCode": "94051"
        },
        "type": "primary"
      }
    ],
    "workloadAccess": false
  }
}

Loading...