List Meetings (POST)

POST

Lists the meeting records.

Request

This endpoint expects an object.
created_dateobjectRequired

Provides ways to specify date ranges on objects.

ended_dateobjectRequired

Provides ways to specify date ranges on objects.

modeenumRequired
Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

modified_dateobjectRequired

Provides ways to specify date ranges on objects.

scheduled_dateobjectRequired

Provides ways to specify date ranges on objects.

channellist of enumsOptional

Filters for meeting on specified channels.

created_bylist of stringsOptional

Filters for meetings created by the specified user(s).

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

custom_fieldsobjectOptional

Filters for meeting on custom fields.

external_reflist of stringsOptional

Filters for meetings with the provided external_ref(s).

limitintegerOptional

The maximum number of meetings to return.

memberslist of stringsOptional

Filter for meeting on specified Member Ids.

organizerlist of stringsOptional

Filter for meeting on specified organizers.

sort_bylist of stringsOptional

Fields to sort the meetings by and the direction to sort them.

statelist of enumsOptional

Filters for meeting on specified state or outcomes.

tagslist of stringsOptional

Filters for meeting by tags.

parentlist of stringsOptionalDeprecated

Filters for meetings with the provided parent.

Response

Success.

meetingslist of objects

The list of meetings.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Built with