API Referencemeetings

List Meetings

Lists the meeting records.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

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.
links.targetstringOptionalformat: "id"
Filters for target id in links associated with the meeting.
links.target_object_typestringOptionalformat: "text"
Filters for target object type in links associated with the meeting.
memberslist of stringsOptional
Filter for meeting on specified Member Ids.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
organizerlist of stringsOptional
Filter for meeting on specified organizers.
parentlist of stringsOptionalDeprecated
Filters for meetings with the provided parent.
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.
subtypelist of stringsOptional
Subtypes of meeting to be filtered.
sync_metadata.external_referencelist of stringsOptional
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_in.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_in.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.last_sync_out.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_out.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_out.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.origin_systemlist of stringsOptional
Filters for issues synced from this specific origin system.
tagslist of stringsOptional
Filters for meeting by tags.

Response

Success.
meetingslist of objects
The list of meetings.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors