CRM

A template's share panel (owner display, canManage, grantees)

getapi.modelmatch.com/v1/crm/templates/{id}/shares

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Responses

200objectOwner display + caller canManage + enriched grantees.

Show attributes

dataobjectrequired

Show child attributes

canManagebooleanrequired

ownerobjectrequired

Show child attributes

emailstring | nullrequired

imagestring | nullrequired

namestring | nullrequired

userIdstringrequired

ownerUserIdstringrequired

sharesobject[]required

Show child attributes

createdAtnumberrequired

emailstring | nullrequired

grantedByNamestring | nullrequired

imagestring | nullrequired

namestring | nullrequired

userIdstringrequired

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectTemplate not found / not accessible to the caller.

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

502objectAuth service unavailable.

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X GET "https://api.modelmatch.com/v1/crm/templates/<id>/shares" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient, Crm } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Crm.getCrmTemplateShares({
  path: {
    id: "<id>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/templates/<id>/shares",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": {
    "canManage": true,
    "owner": {
      "email": "<string>",
      "image": "<string>",
      "name": "<string>",
      "userId": "<string>"
    },
    "ownerUserId": "<string>",
    "shares": [
      {
        "createdAt": 123.45,
        "email": "<string>",
        "grantedByName": "<string>",
        "image": "<string>",
        "name": "<string>",
        "userId": "<string>"
      }
    ]
  }
}