CRM

Cross-record meeting inbox for the caller's visible records

getapi.modelmatch.com/v1/crm/meetings/workspace

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

statusenum

Options:scheduledcancelledcompleted

organizerstring

Restrict to one organizer; omit for anyone on my records.

Responses

200objectMeetings on visible records, soonest first.

Show attributes

dataobject[]required

Show child attributes

attendeesobject[]required

Show child attributes

emailstringrequired

idstringrequired

isOrganizerbooleanrequired

kindenumrequired

Options:recordteammateexternal

namestring | nullrequired

responseStatusenumrequired

Options:needsActionaccepteddeclinedtentative

userIdstring | nullrequired

calendarEventIdstring | nullrequired

calendarHtmlLinkstring | nullrequired

calendarIdstring | nullrequired

calendarProviderenum | nullrequired

Options:googlemicrosoftnull

calendarSyncedAtnumber | nullrequired

cancelReasonenum | nullrequired

Options:cancelledno_shownull

cancelledAtnumber | nullrequired

completedAtnumber | nullrequired

completedByenum | nullrequired

Options:usersystemnull

createdAtnumberrequired

createdByUserIdstringrequired

descriptionstring | nullrequired

endAtnumberrequired

entityIdstringrequired

icalUidstring | nullrequired

idstringrequired

listIdstring | nullrequired

locationstring | nullrequired

startAtnumberrequired

statusenumrequired

Options:scheduledcancelledcompleted

timezonestring | nullrequired

titlestringrequired

canManagebooleanrequired

displayobjectrequired

Show child attributes

branchNamestring

branchNmlsIdstring

cbsaCodestring

citystring

companyNamestring

companyNmlsIdstring

contactCheckedAtnumber

countystring

countyFipsstring

locationstring

namestringrequired

statestring

subtitlestring

unitsnumber

volumenumber

zipstring

entityTypeenumrequired

Options:loagentcompanybranch

overridesobject

Show child attributes

officeobject

[key: string]string

recordNamestringrequired

recordSubtitlestring | nullrequired

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

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

curl -X GET "https://api.modelmatch.com/v1/crm/meetings/workspace" \
  -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.listCrmWorkspaceMeetings();

import os
import requests

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

200 response

{
  "data": [
    {
      "attendees": [
        {
          "email": "<string>",
          "id": "<string>",
          "isOrganizer": true,
          "kind": "record",
          "name": "<string>",
          "responseStatus": "needsAction",
          "userId": "<string>"
        }
      ],
      "calendarEventId": "<string>",
      "calendarHtmlLink": "<string>",
      "calendarId": "<string>",
      "calendarProvider": "google",
      "calendarSyncedAt": 123.45,
      "cancelReason": "cancelled",
      "cancelledAt": 123.45,
      "completedAt": 123.45,
      "completedBy": "user",
      "createdAt": 123.45,
      "createdByUserId": "<string>",
      "description": "<string>",
      "endAt": 123.45,
      "entityId": "<string>",
      "icalUid": "<string>",
      "id": "<string>",
      "listId": "<string>",
      "location": "<string>",
      "startAt": 123.45
    }
  ]
}