Skip to content

Check a community link​

GET
/communities/slug-available

Whether /communities/<slug> is free, and a suggestion when it is not.

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​

Query Parameters

slug
Type
string

Responses​

OK

application/json
JSON
{
"data": {
"slug": "string",
"available": true,
"reason": "string",
"suggestion": "string",
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress