payload.ids | array | No | — | IDs of meetings to fetch. If a record can’t be found, that record won’t be returned and your request will be successful |
payload.status | string | No | — | Filters meetings by status. Possible values are: pending, booked, failed, retry |
payload.person_id | string | No | — | Filters meetings by person_id. Multiple person ids can be applied |
payload.account_id | string | No | — | Filters meetings by account_id. Multiple account ids can be applied |
payload.person_ids | array | No | — | Filters meetings by person_id. Multiple person ids can be applied |
payload.event_ids | array | No | — | List of event IDs. If both event_ids and i_cal_uids params are passed, this filters will be ORed. If a record can’t be found, that record won’t be returned and your request will be successful |
payload.i_cal_uids | array | No | — | List of UIDs provided by calendar provider. If both event_ids and i_cal_uids params are passed, this filters will be ORed. If a record can’t be found, that record won’t be returned and your request will be successful |
payload.task_ids | array | No | — | Filters meetings by task_id. Multiple task ids can be applied |
payload.include_meetings_settings | boolean | No | — | Flag to indicate whether to include owned_by_meetings_settings and booked_by_meetings_settings objects |
payload.start_time | object | No | — | Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision. |
payload.created_at | object | No | — | Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision. |
payload.updated_at | object | No | — | Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision. |
payload.user_guids | array | No | — | Filters meetings by user_guid. Multiple user guids can be applied |
payload.show_deleted | boolean | No | — | Flag to show only canceled events in the results when set to ‘true’. Shows only active events when set to ‘false’ |
payload.booked_by_user_uuid | string | No | — | Filters meetings by booked_by_user_uuid |
payload.no_show | boolean | No | — | Flag to include or exclude ‘no show’ meetings in results |
payload.meeting_type_id | string | No | — | Filters meetings by meeting_type_id. Set to ‘default_personal_meeting’ to filter for default personal meetings. Multiple meeting type ids can be applied |
payload.cadence_id | string | No | — | Filters meetings by cadence_id |
payload.step_id | string | No | — | Filters meetings by step_id |
payload.counted_towards_meetings_attended_metric | boolean | No | — | Filters meetings complying with Meetings Attended configurable metric |
payload.counted_towards_meetings_booked_metric | boolean | No | — | Filters meetings complying with Meetings Booked configurable metric |
payload.recording_failed | boolean | No | — | Filters meetings by recording failure status. Set to ‘true’ to return only meetings with a failed recording. Set to ‘false’ to return only meetings without a failed recording |
payload.sort_by | string | No | — | Key to sort on, must be one of: start_time, created_at, updated_at. Defaults to start_time |
payload.sort_direction | string | No | — | Direction to sort in, must be one of: ASC, DESC. Defaults to DESC |
payload.per_page | integer | No | — | How many records to show per page in the range [1, 100]. Defaults to 25 |
payload.page | integer | No | — | The current page to fetch results from. Defaults to 1 |
payload.include_paging_counts | boolean | No | — | Whether to include total_pages and total_count in the metadata. Defaults to false |
payload.limit_paging_counts | boolean | No | — | Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data |