List Partners

SaaS only

This API is Applicable only for SaaS Environment

This is used by MSP to list all partners.

Params

Search by name or primary contact email: GET /partners?filter=searchTerm:{value}

Filter by workloadAccess: GET /partners?filter=workloadAccess:true

Query Parameters

• filter string

  searchTerm - matches partner name and contact email containing searchTerm value. Apart from searchTerm filter can also be applied on fields like name and workloadAccess.

• sort string

  Optional - Sort order. default desc:updateTs

• pageNumber integer

  Optional - Page number >= 0. default 0

• pageSize integer

  Default value: 25

  Optional - Size of each page. default 25

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• data object[]

  id string

  insertTs string

  updateTs string

  status string

  name string

  primaryEmail string

  website string

  externalId string

  workloadAccess boolean
• metadata object

  filter string

  sort string

  pagination object

  pageNumber integer

  pageSize integer

  totalRecords integer

{
  "data": [
    {
      "id": "string",
      "insertTs": "string",
      "updateTs": "string",
      "status": "string",
      "name": "string",
      "primaryEmail": "string",
      "website": "string",
      "externalId": "string",
      "workloadAccess": true
    }
  ],
  "metadata": {
    "filter": "string",
    "sort": "string",
    "pagination": {
      "pageNumber": 0,
      "pageSize": 0,
      "totalRecords": 0
    }
  }
}

{
  "data": [
    {
      "id": "0DF97076-78B4-4A44-88A2-42F4BF0E3A31",
      "insertTs": "2022-06-21T17:19:00",
      "updateTs": "2022-06-25T00:06:28",
      "status": "active",
      "name": "Partner Tree1",
      "primaryEmail": "admin@partnertree1.com",
      "website": "partnertree1.com",
      "externalId": "partner-tree1",
      "workloadAccess": false
    },
    {
      "id": "126DFC5D-AFA2-42A8-BDAB-B27CC0CCA04E",
      "insertTs": "2022-06-21T17:19:00",
      "updateTs": "2022-06-25T00:06:28",
      "status": "active",
      "name": "Sequoia",
      "primaryEmail": "admin@tree.com",
      "website": "tree.com",
      "externalId": "Sequoia-tree1",
      "workloadAccess": true
    }
  ],
  "metadata": {
    "filter": "searchTerm:tree",
    "sort": "desc:updateTs",
    "pagination": {
      "pageNumber": 0,
      "pageSize": 25,
      "totalRecords": 2
    }
  }
}

Loading...