Saved Filters

Share a saved filter with a workspace member

postapi.modelmatch.com/v1/saved-filters/{id}/shares

Owner or workspace admin only. Re-sharing updates the member's role. Sharing a private filter makes it shared. Sharing with the owner is a no-op (granted: false).

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Saved-filter id (nanoid).

Body application/json

permissionenum

The whole workspace's role on an organization filter; null for private / shared filters.

Options:editorviewernull

userIdstringrequired

Responses

200objectWhether a new share was created (false when an existing one was updated).

Show attributes

dataobjectrequired

Show child attributes

grantedbooleanrequired

400objectValidation error, or (`code: NOT_ORG_MEMBER`) the user is not a member of your workspace.

401objectUnauthorized

403objectNo active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this.

404objectNo saved filter with that id is visible to the caller (their own, or shared with them).

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

502objectWorkspace members could not be read (auth service unavailable).

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

curl -X POST "https://api.modelmatch.com/v1/saved-filters/V1StGXR8_Z5jdHi6B-myT/shares" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "<string>",
    "permission": "editor"
  }'

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

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

const { data, error } = await SavedFilters.grantSavedFilterAccess({
  path: {
    id: "V1StGXR8_Z5jdHi6B-myT"
  },
  body: {
    userId: "<string>",
    permission: "editor"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/saved-filters/V1StGXR8_Z5jdHi6B-myT/shares",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "userId": "<string>",
        "permission": "editor"
    },
)
data = res.json()

200 response

{
  "data": {
    "granted": true
  }
}