Overview
The transcripts query is designed to fetch a list of transcripts against input arguments.Arguments
This field is deprecated. Please use
keyword
instead.Title of the transcriptThis argument is mutually exclusive with keyword
fieldThe maximum allowable length for this field is 256
characters.Allows searching for keywords in meeting title and/or words spoken during the meetingThis argument is mutually exclusive with
title
fieldThe maximum allowable length for this field is 255
characters.Specify the scope for keyword search.If scope is provided,
keyword
becomes a required fieldDefaults to TITLE
if no value is providedThe available options for this field are:title
: Search within the title.sentences
: Search within the sentences.all
: Search within title and sentences.
Return all transcripts created after
fromDate
. The fromDate
parameter accepts a date-time
string in the ISO 8601 format, specifically in the form YYYY-MM-DDTHH:mm.sssZ
. For example, a
valid timestamp would be 2024-07-08T22:13:46.660Z
.Return all transcripts created before
toDate
. The toDate
parameter accepts a date-time string
in the ISO 8601 format, specifically in the form YYYY-MM-DDTHH:mm.sssZ
. For example, a valid
timestamp would be 2024-07-08T22:13:46.660Z
. This field is deprecated. Please use
fromDate
and toDate
instead.Return all transcripts created within the date specified. Query input value must be in milliseconds.
For example, you can use the JavaScript new Date().getTime()
to get the datetime in milliseconds
which should look like this 1621292557453
. The timezone for this field is UTC +00:00For more details regarding time since EPOCHNumber of transcripts to return. Maxiumum 50 in one query
Number of transcripts to skip.
Filter all meetings accordingly to meetings that have this email as the host.
This field is deprecated. Please use
organizers
instead.
Filter meetings that have this email as the organizer.This field is deprecated. Please use
participants
instead.
Filter meetings that contain this email as an attendee.Filter all meetings that have the API key owner as the organizer.
Filter meetings that have any of these emails as organizers. Accepts an array of email addresses.Cannot be combined with the deprecated
organizer_email
or participant_email
fields.Each email must be valid and 256 characters or fewer.Filter meetings that contain any of these emails as attendees. Accepts an array of email addresses.Cannot be combined with the deprecated
organizer_email
or participant_email
fields.Each email must be valid and 256 characters or fewer.Filter meetings that belong to a specific channel. Accepts a single channel ID.The channel ID must be a valid string and 256 characters or fewer.
Schema
Fields available to the Transcript queryUsage Example
Error Codes
List of possible error codes that may be returned by thetranscripts
query. Full list of error codes can be found here.
object_not_found (user)
object_not_found (user)
The user ID you are trying to query does not exist or you do not have access to it.