MImiitel
meetings

Search meetings

List meetings that match the supplied filters.

Results use cursor pagination. Send page_info.end_cursor as after to retrieve the next page.

post/public-api/v1/meetings/list

Request

  • Base URL
    / (relative, and the document’s source URL is not known)
  • URL
    /public-api/v1/meetings/list
  • Auth
    HTTP bearer and API key in header x-tenant-code

Request body

firstinteger

Forward page size. 1 to 200.

offsetinteger nullable

Offset-based pagination start (0 to 5000). Mutually exclusive with after — sending both is a 422.

afterstring nullable

Opaque pagination cursor from a previous response's page_info.end_cursor (next page) or page_info.start_cursor (previous page). Omit for the first page. When set, the page size comes from the cursor. Mutually exclusive with offset.

keywordstring nullable

Free-text match against the video title and participant names.

starts_atstring date-time nullable

Lower bound on the meeting start time (inclusive).

ends_atstring date-time nullable

Upper bound on the meeting start time (inclusive).

platformsVideoPlatform[]

Restrict to these recording platforms.

participant_idsstring[]

Restrict to videos with these participant user ids (numeric).

host_idsstring[]

Restrict to videos hosted by these user ids (numeric).

my_meetingsboolean

When true, restrict to meetings the caller hosted or joined.

duration__gteinteger nullable

Minimum meeting duration, in seconds.

duration__lteinteger nullable

Maximum meeting duration, in seconds.

playback_users__gteinteger nullable

Minimum number of distinct playback users.

playback_users__lteinteger nullable

Maximum number of distinct playback users.

status'ALL' | 'AWAITING_RECPOD_UPLOAD' | 'ANALYSIS_COMPLETE' | 'ANALYSIS_FAILED'

The analysis status of a recording. Used by the status filter.

tag_ids__include_andstring[]

Require videos to carry all of these tag ids.

tag_ids__include_orstring[]

Require videos to carry any of these tag ids (ignored if tag_ids__include_and is set).

tag_ids__excludestring[]

Exclude videos carrying any of these tag ids.

tag__existsboolean nullable

When set, restrict to videos that do (true) / do not (false) carry tags.

video_idsstring[]

Restrict to these specific video ids.

commentstring nullable

Free-text match against comments on the video.

Example request

{
  "first": 5,
  "my_meetings": true
}

Response

A page of matching meetings and pagination cursors.

Changes

No recorded changes to this operation across all 1 revision of this API.