CRM

List the direct shares on a record (+ display, canManageShares)

getapi.modelmatch.com/v1/crm/record-shares

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

entityIdstringrequired

The record's entity id.

Responses

200objectThe per-user share grants on the record, with display.

Show attributes

dataobjectrequired

Show child attributes

canManageSharesbooleanrequired

sharesobject[]required

Show child attributes

createdAtnumberrequired

emailstring | nullrequired

grantedByNamestring | nullrequired

imagestring | nullrequired

namestring | nullrequired

sourcestringrequired

userIdstringrequired

400objectValidation error

401objectUnauthorized

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

404objectNot found

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/record-shares?entityId=%3Cstring%3E" \
  -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.listCrmRecordShares({
  query: {
    entityId: "<entityId>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/record-shares?entityId=%3Cstring%3E",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

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