Skip to main content

List Partners

Select

SaaS

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

OK


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
GET /api/v1/partner/partners    

Authorization

Request

Click Edit to configure Base URL
https://api.metallic.io
Bearer Token
filter — query
sort — query
pageNumber — query
pageSize — query
lhAccountId — header
curl -L -X GET 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'