Skip to content

My membership settings​

GET
/communities/{key}/me

The caller's role and alert choice in this community.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*

The community's slug or uuid.

Type
string
Required

Responses​

OK

application/json
JSON
{
"data": {
"role": "string",
"status": "string",
"alert_level": "string",
"channels": {
"email": true,
"push": true,
"web": true,
"additionalProperties": "string"
},
"muted_until": "string",
"pinned_home": true,
"joined_at": "string",
"joined_via": "string",
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress