--- title: "List video conferences" method: GET path: "/api/video/conferences" tags: ["Video Conferences"] --- # List video conferences `GET /api/video/conferences` List Video Conferences. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). ## Query parameters - `starts_after` string - `ends_before` string - `include_active_session` boolean - `page_number` integer - `page_size` integer - `page_token` string ## Response `200` The request has succeeded. - VideoListConferencesResponse — List conferences response. - `links` VideoPaginationLinks, required — Pagination links for list responses. - `self` string, required — Link to the current page. - `first` string, required — Link to the first page. - `next` string — Link to the next page. - `prev` string — Link to the previous page. - `data` VideoConference[], required — List of conferences. - `id` string, uuid, required — Universal Unique Identifier. - `name` string, required — A named unique identifier for the conference. Allowed characters: `A-Za-z0-9_-`. - `display_name` string, nullable, required — Display name of the video conference. Maximum of 200 characters. - `description` string, nullable, required — Description of the conference. Maximum of 3000 characters. - `join_from` string, date-time, nullable, required — Conference does not accept new participants before this time. - `join_until` string, date-time, nullable, required — Conference stops accepting new participants at this time, but keeps running until all participants leave. - `quality` '720p' | '1080p', required — Video quality resolution. - `layout` 'grid-responsive' | 'grid-responsive-mobile' | 'highlight-1-responsive' | '1x1' | '2x1' | '2x2' | '5up' | '3x3' | '4x4' | '5x5' | '6x6' | '8x8' | '10x10', required — Video room layout options. - `size` 'small' | 'medium' | 'large', required — Conference size options. - `record_on_start` boolean, required — Whether to start recording when a conference session begins. - `tone_on_entry_and_exit` boolean, required — Whether a tone is played when a member enters or exits the conference. - `user_join_video_off` boolean, required — Whether participants join with video off by user setting. - `room_join_video_off` boolean, required — Whether participants join with video off by room setting. - `enable_chat` boolean, required — Whether group chat is enabled for conference participants. - `enable_room_previews` boolean, nullable, required — Whether a preview video of the conference content is generated. - `dark_primary` string, nullable, required — CTA buttons and selected items color (dark theme). - `dark_background` string, nullable, required — Main background color (dark theme). - `dark_foreground` string, nullable, required — Main foreground color (dark theme). - `dark_success` string, nullable, required — Success indication color (dark theme). - `dark_negative` string, nullable, required — Error indication color (dark theme). - `light_primary` string, nullable, required — CTA buttons and selected items color (light theme). - `light_background` string, nullable, required — Main background color (light theme). - `light_foreground` string, nullable, required — Main foreground color (light theme). - `light_success` string, nullable, required — Success indication color (light theme). - `light_negative` string, nullable, required — Error indication color (light theme). - `meta` object, nullable, required — User-defined metadata for the conference. - `created_at` string, date-time, required — Timestamp when the conference was created. - `updated_at` string, date-time, required — Timestamp when the conference was last updated. - `active_session` VideoActiveSession — Active session information for a room. - `id` string — Unique ID of the session. - `room_id` string — Unique ID of the Room if the Session was created from a Room and was not an auto-created Session. - `name` string — The named identifier of room session. - `display_name` string — Display name of room, no character limitations. Maximum of 200 characters. Defaults to the value of name. - `join_from` string, date-time — Room Session does not accept new Members before this time. - `join_until` string, date-time — Room Session stops accepting new Members at this time. - `remove_at` string, date-time — Remove Members from the Room Session at this time. - `remove_after_seconds_elapsed` integer — Remove Members after they are in the Room Session for N seconds. - `layout` string — The Room Session's initial layout. See documentation for a full list of supported layouts. - `max_members` integer — The maximum number of members allowed in the room at a time. - `fps` 20 | 30 — Video frames per second. - `quality` '720p' | '1080p' — Video quality resolution. - `start_time` string, date-time — Start time of the session. - `end_time` string, date-time — End time of the session. - `duration` integer — How long, in seconds, the Room Session lasted. - `status` 'in-progress' | 'completed' — Status of a room session. - `record_on_start` boolean — Whether a recording was automatically started when this Room Session began. - `enable_room_previews` boolean — Whether a video with a preview of the content of the room is to be generated. - `preview_url` string — If room previews are enabled and the room session is in progress, this is the URL of the preview video. - `audio_video_sync` boolean — Enable/disable jitter buffer audio-video sync. ## Other responses - `400` — The request is invalid. - `401` — Access is unauthorized. - `422` — The request contains invalid parameters. See errors for details. - `500` — An internal server error occurred. --- [API](https://skmtc.net/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.net/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/signalwire/signalwire-rest-api/versions/05c5164b85c7/schema)