Skip to main content
Check My Membership
Returns the acting user’s membership in a conversation: the token’s user, or the user a service key names in actingUserId. me in the path always means that user. Who may ask is exactly who may read the conversation: anyone else gets the same 404 or 403 that read gives them.
Your own membership is /chat/conversations/:conversationId/members/me: GET to check it, DELETE to leave. The /chat/conversations/:conversationId/members/:userId routes (remove, change role) act on other members and refuse your own id with 400 chat/own-member-id.

Path Parameters

string
required
The ID of the conversation.

Query Parameters

string
Service key only, and required with one: the user this request acts as, whose membership is returned. A user token always acts as its own user and must not send it (400 chat/acting-user-not-allowed).

Response

A flat object. isMember is always present; a field that describes a membership the user doesn’t have is left out, not sent as null. There are three shapes:
boolean
Whether the user is an active member of the conversation.
string | null
"admin" or "member" in a group conversation; null in direct and space conversations, which have no roles. Present only when isMember is true.
string | null
When the user last marked the conversation as read, or null if never. Present only when isMember is true.
boolean
true when the user muted the conversation with no end. Present only when isMember is true.
string | null
When a timed mute ends; null when the conversation isn’t muted or is muted forever. Present only when isMember is true.
string | null
When the user left the conversation or was removed from it. Present only when the user has a membership that is no longer active.
An active member
A user who left or was removed
A user with no membership yet (a space conversation they haven't opened)

Error Responses

Returned when conversationId isn’t a valid UUID.
The request had no credentials. The body is text/plain (Unauthorized), not JSON. An expired or invalid token returns 403 instead — see Authentication.
A service key sent no actingUserId.
A user token sent actingUserId, even naming its own user. Only a service key names the user it acts as; a user token always acts as its own user.
Returned when a service key names an actingUserId that isn’t a user in this project.
The request sent userId. On this route the user a service key acts as is actingUserId.With a service key:
With a user token:
The user can’t read the conversation: a direct or group conversation they were never in, or a space conversation whose space they can’t take part in (see List Members).
See also: useCheckMyConversationMembership · Leave Conversation