Details

The Community API provides a comprehensive set of endpoints to interact with a community, including community details and membership.

The Community Details API allows you to retrieve information about a community using either its ID or slug. This API provides valuable insights into community metrics and content.

Community

Retrieve community details using either its id or slug

get

Path parameters

communityIdstringRequired

The id or slug of the community

Responses

400

Generic Client Error

application/json

401

Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.

application/json

404

Generic not found

application/json

500

Internal server error

application/json

default

application/json

get

HTTPcURLJavaScriptPython

GET /v1/community/{communityId} HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Communities

GET /v1/community

Fetches all communities

get

Query parameters

pagenumberRequired

onlyJoinedbooleanRequired

Responses

400

Generic Client Error

application/json

401

Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.

application/json

404

Generic not found

application/json

500

Internal server error

application/json

default

application/json

get

HTTPcURLJavaScriptPython

GET /v1/community?page=1&onlyJoined=true HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Ranking

Fetch a users ranking in a community for a resource

get

Path parameters

idstringRequired

slugstringRequired

Responses

400

Generic Client Error

application/json

401

Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.

application/json

404

Generic not found

application/json

500

Internal server error

application/json

default

application/json

get

HTTPcURLJavaScriptPython

GET /v1/community/{id}/ranking/{slug} HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Leaderboard

GET /v1/community/{id}/leaderboard/{slug}

Retrieve a community resource leaderboard

get

Path parameters

idstringRequired

slugstringRequired

Responses

400

Generic Client Error

application/json

401

Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.

application/json

404

Generic not found

application/json

500

Internal server error

application/json

default

application/json

get

HTTPcURLJavaScriptPython

GET /v1/community/{id}/leaderboard/{slug} HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Membership

Join a community

post

Path parameters

communityIdstringRequired

Query parameters

referrerHandlestringRequired

Responses

400

Generic Client Error

application/json

401

Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.

application/json

404

Generic not found

application/json

500

Internal server error

application/json

default

application/json

post

HTTPcURLJavaScriptPython

POST /v1/community/{communityId}/join?referrerHandle=text HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Leave a community

post

Path parameters

communityIdstringRequired

Responses

400

Generic Client Error

application/json

401

Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.

application/json

404

Generic not found

application/json

500

Internal server error

application/json

default

application/json

post

HTTPcURLJavaScriptPython

POST /v1/community/{communityId}/leave HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Return a users community referrals

get

Path parameters

communityIdstringRequired

Responses

400

Generic Client Error

application/json

401

Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.

application/json

404

Generic not found

application/json

500

Internal server error

application/json

default

application/json

get

HTTPcURLJavaScriptPython

GET /v1/community/{communityId}/referrals HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}