CRM

List the org members a record can be shared with (manage-gated)

getapi.modelmatch.com/v1/crm/record-shareable-members

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

entityIdstringrequired

The record's entity id.

Responses

200objectThe org roster for the record's share picker (all members).

Show attributes

dataobjectrequired

Show child attributes

membersobject[]required

Show child attributes

emailstring | nullrequired

imagestring | nullrequired

namestring | nullrequired

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-shareable-members?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.listCrmRecordShareableMembers({
  query: {
    entityId: "<entityId>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "members": [
      {
        "email": "<string>",
        "image": "<string>",
        "name": "<string>",
        "userId": "<string>"
      }
    ]
  }
}