Join a community
POST
/communities/{key}/join
One tap for a public community without approval; a request otherwise. A share link without approval (made by an owner or leader) joins directly. 402 PAYMENT_REQUIRED for a paid community; 403 REMOVED for a removed person.
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
Requiredstring
Request Body
application/json
JSON
{
"invite": "string",
"via": "string",
"additionalProperties": "string"
}
Responses
OK
application/json
JSON
{
"data": {
"status": "string",
"viewer": {
"additionalProperties": "string"
},
"additionalProperties": "string"
},
"additionalProperties": "string"
}