Categories

List categories

get
Query parameters
showOnLeaderboardbooleanOptional
showInDailyServicebooleanOptional
withUserCountbooleanOptional
limitnumberOptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
chevron-right
200

Successful response

application/json
get
/categories

Create a new category

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
slugstring · min: 1 · max: 50Optional
namestringRequired
descriptionstringOptional
showOnLeaderboardbooleanRequired
showInDailyServicebooleanRequired
bannerImageUrlstring · uriOptional
Responses
chevron-right
200

Successful response

application/json
post
/categories

Get a specific category by ID

get
Path parameters
idinteger · max: 2147483647Required
Responses
chevron-right
200

Successful response

application/json
get
/categories/{id}

Get summaries for multiple categories

get
Query parameters
showOnLeaderboardbooleanOptional
showInDailyServicebooleanOptional
topUsersLimitnumber · max: 50OptionalDefault: 10
Responses
chevron-right
200

Successful response

application/json
get
/categories/summaries/bulk

Update an existing category

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
categoryIdinteger · max: 2147483647Required
Body
slugstring · min: 1 · max: 50Optional
namestringOptional
descriptionstringOptional
showOnLeaderboardbooleanOptional
showInDailyServicebooleanOptional
bannerImageUrlstring · uriOptional
Responses
chevron-right
200

Successful response

application/json
put
/categories/{categoryId}

Delete a category

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
categoryIdinteger · max: 2147483647Required
Responses
chevron-right
200

Successful response

application/json
delete
/categories/{categoryId}

Get users belonging to a category

get
Path parameters
categoryIdinteger · max: 2147483647Required
Query parameters
limitnumberOptionalDefault: 50
offsetnumberOptionalDefault: 0
searchTextstringOptional
orderBystring · enumOptionalDefault: createdAtPossible values:
Responses
chevron-right
200

Successful response

application/json
get
/categories/{categoryId}/users

Add users to a category

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
categoryIdinteger · max: 2147483647Required
Body
userIdsinteger[] · min: 1Required
Responses
chevron-right
200

Successful response

application/json
post
/categories/{categoryId}/users

Remove users from a category

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
categoryIdinteger · max: 2147483647Required
Query parameters
userIdsinteger[] · min: 1Required
Responses
chevron-right
200

Successful response

application/json
delete
/categories/{categoryId}/users

Bulk import users to a category via Twitter URLs

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
categoryIdinteger · max: 2147483647Required
Body
twitterUrlsstring[] · min: 1Required
Responses
chevron-right
200

Successful response

application/json
post
/categories/{categoryId}/bulk-import

List requests to join categories

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
statusstring · enumOptionalPossible values:
limitnumberOptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
chevron-right
200

Successful response

application/json
get
/categories/requests

Update category request status

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
requestIdnumberRequired
Body
categoryIdinteger · max: 2147483647Optional
userIdinteger · max: 2147483647Optional
statusstring · enumRequiredPossible values:
Responses
chevron-right
200

Successful response

application/json
put
/categories/requests/{requestId}/status

Last updated