Qodex.ai

Retrieve a list of rooms

GET https://api-{{APP_ID}}.calls.sendbird.com/v1/rooms

Retrieve a list of rooms

Retrieves all rooms within the application. The retrieved list of rooms are sorted in reverse order, meaning the newest room appears first and the oldest last.

For more information, visit:

https://sendbird.com/docs/calls/v1/platform-api/guides/group-call#2-retrieve-a-list-of-rooms

URL Parameters

Required

Request Params

KeyDatatypeRequiredDescription
limitstringOPTIONAL: Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)
nextstringOPTIONAL: Specifies the value of the next property in the response to retrieve the next page in the result set.
typestringOPTIONAL: Restricts the search scope to only retrieve rooms of which the type matches any of the specified values. Acceptable values are limited to all, large_room_for_audio_only, and small_room_for_video. (Default: all)
room_idsstringOPTIONAL: Searches for rooms which the specified room IDs are included in the parameter value. The string should consist of multiple URL encoded room IDs separated by commas.</br>Example:</br>?room_ids=urlencoded_id_1, urlencoded_id_2</br></br> The room_id can be used interchangeably with this parameter, but can only specify one room ID. When both room_id and room_ids are specified, an error will be returned.</br> The maximum number of room IDs in a single request is 10.
statestringOPTIONAL: Restricts the search scope to only retrieve rooms of which state matches any of the specified value. Acceptable values are limited to open and deleted.
created_at_start_datestringOPTIONAL: Specifies the value of time period to restrict the search scope to only retrieve rooms of which the rooms created_at is equal to or greater than the specified value, in Unix milliseconds. The search scope may be specified in conjunction with the created_at_end_date parameter. When both the start date and end date arent provided, the start date will be set to 2 weeks prior to the date which the request was made by default.
created_at_end_datestringOPTIONAL: Specifies the value of time period to restrict the search scope to only retrieve rooms of which the rooms created_at is less than the specified value, in Unix milliseconds. The search scope may be specified in conjunction with the created_at_start_date parameter.
current_participant_range_gtestringOPTIONAL: Specifies the number of current participants to restrict the search scope to only retrieve rooms which the number of participants is equal to or greater than the specified value. The search scope may be specified in conjunction with the current_participant_range_lte parameter.
current_participant_range_ltestringOPTIONAL: Specifies the number of current participants to restrict the search scope to only retrieve rooms which the number of participants is equal to or less than the specified value. The search scope may be specified in conjunction with the current_participant_range_gte parameter.
created_by_user_idsstringOPTIONAL: Searches for rooms which the specified user IDs of users who created rooms are included in the parameter value. The string should consist of multiple URL encoded user IDs separated by commas.</br>Example:</br>?created_by_user_ids=urlencoded_id_1, urlencoded_id_2</br></br> The created_by_user_id can be used interchangeably with this parameter, but can only specify one user ID. When both created_by_user_id and created_by_user_ids are specified, an error will be returned.</br> The maximum number of user IDs in a single request is 10.

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring