List Preferred Partners

Active Preferred Partner agreements for the account that owns the key.

serviceIdRequired is true when the category has more than one service other than a single Default row.

GET/api/partners

Authorization

X-CM-API-KEYAPI key · headerrequired

Account key from Integrations. Keys use the cm_ prefix.

Responses

200

The account's active Preferred Partners.

partnersPartner[]required

Show properties

Array of Partner

agreementIdstringrequired

namestring | nullrequired

categoriesPartnerCategory[]required

Show properties

Array of PartnerCategory

idstringrequired

namestringrequired

serviceIdRequiredbooleanrequired

True when the category has more than one service other than a single Default row.

servicesService[]required

Show properties

Array of Service

idstringrequired

namestringrequired

401

The key is missing or unknown.

errorstringrequired

403

The key cannot send leads.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Request

curl -X GET 'https://www.comarketing.com/api/partners' \
  -H 'X-CM-API-KEY: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("https://www.comarketing.com/api/partners", {
  method: "GET",
  headers: {
    "X-CM-API-KEY": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://www.comarketing.com/api/partners",
    headers={
        "X-CM-API-KEY": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

Response

{
  "partners": [
    {
      "agreementId": "agr_id",
      "name": "Northside Moving",
      "categories": [
        {
          "id": "cat_id",
          "name": "Moving",
          "serviceIdRequired": false,
          "services": [
            {
              "id": "svc_id",
              "name": "Default"
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": "Invalid API key."
}

{
  "error": "This key cannot send leads."
}