CRM

Get a list's sharing state (+ owner display, canManageSharing)

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

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Responses

200objectVisibility + owner display + enriched grants, or null.

Show attributes

dataobject | nullrequired

Show child attributes

canManageSharingbooleanrequired

orgWidePermissionenumrequired

Options:viewereditor

ownerobjectrequired

Show child attributes

emailstring | nullrequired

imagestring | nullrequired

namestring | nullrequired

userIdstringrequired

ownerUserIdstringrequired

sharesobject[]required

Show child attributes

createdAtnumberrequired

emailstring | nullrequired

idstringrequired

imagestring | nullrequired

invitedByNamestring | nullrequired

namestring | nullrequired

permissionenumrequired

Options:ownereditorviewer

userIdstringrequired

visibilityenumrequired

Options:privateorganizationshared

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/lists/<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.getCrmListShares({
  path: {
    id: "<id>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "canManageSharing": true,
    "orgWidePermission": "viewer",
    "owner": {
      "email": "<string>",
      "image": "<string>",
      "name": "<string>",
      "userId": "<string>"
    },
    "ownerUserId": "<string>",
    "shares": [
      {
        "createdAt": 123.45,
        "email": "<string>",
        "id": "<string>",
        "image": "<string>",
        "invitedByName": "<string>",
        "name": "<string>",
        "permission": "owner",
        "userId": "<string>"
      }
    ],
    "visibility": "private"
  }
}