Details

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

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

/v1/community/{id}/ranking/{slug}

HTTPcURLJavaScriptPython

GET /v1/community/{id}/ranking/{slug} HTTP/1.1
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

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

HTTPcURLJavaScriptPython

GET /v1/community/{id}/leaderboard/{slug} HTTP/1.1
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

/v1/community/{communityId}/join

HTTPcURLJavaScriptPython

POST /v1/community/{communityId}/join?referrerHandle=text HTTP/1.1
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

/v1/community/{communityId}/referrals

HTTPcURLJavaScriptPython

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

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