v1

latestOpenAPI 3.1.12026-07-2692827.1 KB

Meetings

List meetings

get/meetings

Query parameters

calendar_invitees_domains[]string[]

Domains of the companies to filter by. Exact match.

Pass the parameter once per value, e.g. calendar_invitees_domains[]=acme.com&calendar_invitees_domains[]=client.com.

Returns meetings whose associated company matches one of the specified domains. (Note that meetings are only associated with one company.)

[
  "acme.com",
  "client.com"
]

calendar_invitees_domains_type'all' | 'only_internal' | 'one_or_more_external'

Filter by whether calendar invitee list includes external email domains.

created_afterstring

Filter to meetings with created_at after this timestamp, e.g. created_after=2025-01-01T00:00:00Z.

created_beforestring

Filter to meetings with created_at before this timestamp, e.g. created_before=2025-01-01T00:00:00Z.

cursorstring

Cursor for pagination.

include_action_itemsboolean

Include the action items for each meeting.

include_crm_matchesboolean

Include CRM matches for each meeting. Only returns data from your or your team's linked CRM.

include_highlightsboolean

Include the highlights for each meeting.

include_summaryboolean

Include the summary for each meeting. Unavailable for OAuth connected apps (use /recordings instead).

include_transcriptboolean

Include the transcript for each meeting. Unavailable for OAuth connected apps (use /recordings instead).

meeting_typestring

Example:Quarterly Business Review

Filter by meeting type name.

Returns only meetings assigned the meeting type with this name. Use /meeting_types to discover valid values. An unknown or non-matching name returns an empty list.

recorded_by[]string[]

Email addresses of users who recorded meetings.

Pass the parameter once per value, e.g. recorded_by[]=ceo@acme.com&recorded_by[]=pm@acme.com.

Returns meetings recorded by any of the specified users.

If no value is passed (or with teams[]), calls from users external to your Org will not be returned.

[
  "ceo@acme.com",
  "pm@acme.com"
]

teams[]string[]

Team names to filter by.

Pass the parameter once per value, e.g. teams[]=Sales&teams[]=Engineering.

Returns meetings that belong to any of the specified teams.

If no value is passed (or with recorded_by[]), calls from users external to your Org will not be returned.

[
  "Sales",
  "Engineering"
]

Response

Paginated list of meetings.

limitinteger nullable required

next_cursorstring nullable required

Example response

{
  "limit": 1,
  "next_cursor": "eyJwYWdlX251bSI6Mn0=",
  "items": [
    {
      "title": "Quarterly Business Review",
      "meeting_title": "QBR 2025 Q1",
      "meeting_type": "Quarterly Business Review",
      "recording_id": 123456789,
      "url": "https://fathom.video/xyz123",
      "meeting_url": "https://us02web.zoom.us/j/123456789",
      "share_url": "https://fathom.video/share/xyz123",
      "created_at": "2025-03-01T17:01:30Z",
      "scheduled_start_time": "2025-03-01T16:00:00Z",
      "scheduled_end_time": "2025-03-01T17:00:00Z",
      "recording_start_time": "2025-03-01T16:01:12Z",
      "recording_end_time": "2025-03-01T17:00:55Z",
      "calendar_invitees_domains_type": "one_or_more_external",
      "shared_with": "single_team",
      "transcript_language": "en",
      "transcript": [
        {
          "speaker": {
            "display_name": "Alice Johnson",
            "matched_calendar_invitee_email": "alice.johnson@acme.com"
          },
          "text": "Let's revisit the budget allocations.",
          "timestamp": "00:05:32"
        }
      ],
      "default_summary": {
        "template_name": "general",
        "markdown_formatted": "## Summary\nWe reviewed Q1 OKRs, identified budget risks, and agreed to revisit projections next month.\n"
      },
      "action_items": [
        {
          "description": "Email revised proposal to client",
          "recording_timestamp": "00:10:45",
          "recording_playback_url": "https://fathom.video/xyz123#t=645",
          "assignee": {
            "name": "Alice Johnson",
            "email": "alice.johnson@acme.com",
            "team": "Marketing"
          }
        }
      ],
      "highlights": [
        {
          "type": "Objection",
          "summary": "Pushed back on price",
          "text": "They pushed back hard on the price",
          "start_time": 16,
          "end_time": 27.5
        }
      ],
      "calendar_invitees": [
        {
          "name": "Alice Johnson",
          "matched_speaker_display_name": "Alice Johnson",
          "email": "alice.johnson@acme.com",
          "email_domain": "acme.com"
        }
      ],
      "recorded_by": {
        "name": "Alice Johnson",
        "email": "alice.johnson@acme.com",
        "email_domain": "acme.com",
        "team": "Marketing"
      },
      "crm_matches": {
        "contacts": [
          {
            "name": "Jane Smith",
            "email": "jane.smith@client.com",
            "record_url": "https://app.hubspot.com/contacts/123"
          }
        ],
        "companies": [
          {
            "name": "Acme Corp",
            "record_url": "https://app.hubspot.com/companies/456"
          }
        ],
        "deals": [
          {
            "name": "Q1 Renewal",
            "amount": 50000,
            "record_url": "https://app.hubspot.com/deals/789"
          }
        ],
        "error": "no CRM connected"
      }
    }
  ]
}