Chatrooms

List the members of a chatroom the user belongs to.

post/v1/get_chatroom_membership

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/get_chatroom_membership
  • Auth: API key in header X-Partner-Key

Request body

preferred_languagestring nullable

BCP-47-ish language code (e.g. 'en', 'zh-cn') for localized messages.

pageinteger nullable
page_sizeinteger

Maximum records requested for one server-capped page.

sort_bystring nullable
sort_orderinteger nullable

Sort direction; supported values depend on the operation.

use_cursor_paginationboolean nullable
cursor_valuestring nullable

Opaque pagination cursor value from the previous page (next_cursor_value).

cursor_idstring nullable

Opaque pagination cursor id from the previous page (next_cursor_id).

usernamestring nullable

The end-user's username.

passwordstring nullable

The end-user's password on first sign-in. After login/register, send the returned session token (JWT) here instead — the field accepts either, and reusing the token keeps raw passwords out of your storage.

chatroom_idstring nullable

Chatroom id as returned by chatroom operations.

Response

Result envelope — check the success field.

successboolean

Whether the call succeeded.

error_messagestring nullable

Human-readable reason when success is false.

error_codestring
total_countinteger nullable
pageinteger nullable
page_sizeinteger nullable

Maximum records requested for one server-capped page.

total_pagesinteger nullable
has_nextboolean nullable

True when another page is available after this response.

has_prevboolean nullable
next_cursor_valuestring nullable

Pass as cursor_value on the next page request.

next_cursor_idstring nullable

Pass as cursor_id on the next page request.

membershipsobject[] nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.