CLclose
activities.meetings

Get a single Meeting activity

Changed on

Meeting transcripts can be accessed using this API but are not loaded by default. To load transcripts, use the _fields parameter with transcripts value.

The transcripts field is an array of objects for each Close Notetaker bot that joined the meeting. Typically, there will be only one transcript. Transcripts are ordered by the time bots joined the meeting.

Example transcripts in response:

{ "transcripts": [ { "utterances": [ { "speaker_label": "John Lead", "speaker_side": "contact", "start": 0.1, "end": 1.2, "text": "Hey, what's up? How is it going?" }, { "speaker_label": "Jane User", "speaker_side": "close-user", "start": 1.3, "end": 2.4, "text": "Hey John, I'm doing great. How about you?" } ], "summary_text": "Summary text", "summary_html": "<p>Summary text</p>" } ] }
get/activity/meeting/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/meeting/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Query parameters

_fieldsstring

Comma-separated list of fields to include in the response.

Response

Successful response

_typestring required
activity_atstring date-time nullable required
actual_durationinteger nullable required
agent_config_idstring nullable

Deprecated. Use created_by_agent_id instead.

attached_call_idsstring[] required
calendar_event_linkstring nullable required
calendar_event_uidsstring[] required
connected_account_idstring nullable required
contact_idstring nullable required
conversation_type_idstring nullable required
conversation_type_reason'user-selected' | 'autodetected' required

How the value was chosen: user-selected by a user, or autodetected by AI.

created_bystring nullable required
created_by_agent_idstring nullable
created_by_namestring nullable
date_createdstring date-time required
date_updatedstring date-time required
durationinteger required
ends_atstring date-time required
idstring required
integrationsobject[] required
is_recurringboolean required
lead_idstring nullable required
locationstring required
notestring required
notetaker_idstring nullable required
organization_idstring required
outcome_autofill_confidence'low' | 'medium' | 'high' required

How confident AI was in an Outcome it autofilled.

outcome_autofill_reasoningstring nullable required
outcome_idstring nullable required
outcome_reason'autofilled' | 'user-selected' | 'voicemail-dropped' required

How the Outcome was set: autofilled by AI, user-selected by a user, or voicemail-dropped automatically after a voicemail drop.

playbook_idstring nullable required
playbook_reason'user-selected' | 'autodetected' required

How the value was chosen: user-selected by a user, or autodetected by AI.

provider_calendar_event_idstring nullable required
provider_calendar_idsstring[] required
provider_calendar_type'google' | 'microsoft' required

The calendar provider a Meeting was synced from.

source'calendar' | 'manual' required

How the Meeting got into Close: calendar if it was synced from a connected calendar, manual if it was created in Close.

starts_atstring date-time required
status'upcoming' | 'in-progress' | 'completed' | 'canceled' | 'declined-by-org' | 'declined-by-lead' required

Status of the Meeting. canceled means it was removed from the synced calendars or has no Lead participants left. declined-by-org means every Close user declined it, declined-by-lead that a Lead participant declined it and none accepted.

titlestring required
updated_bystring nullable required
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
user_notestring nullable required
user_note_date_updatedstring date-time nullable required
user_note_htmlstring nullable required
user_note_mentionsstring[] required
usersstring[] required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the response body for the status

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status