CRM

Who can access a record, and whether the caller may manage shares

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

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

entityIdstringrequired

The record's entity id.

Responses

200objectThe resolved accessible-user set + the caller's manage capability.

Show attributes

dataobjectrequired

Show child attributes

accessibleUserIdsstring[]required

canManageSharesbooleanrequired

everyonebooleanrequired

400objectValidation error

401objectUnauthorized

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

404objectRecord 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/record-access?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.getCrmRecordAccess({
  query: {
    entityId: "<entityId>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "accessibleUserIds": [
      "<string>"
    ],
    "canManageShares": true,
    "everyone": true
  }
}