Community - WorkMonger

Feed Notification Portal Post Questions Topics Users Groups Search Virtual Currency Errors Widgets Request API Credentials Introduction Welcome to the Tribe API! We have language bindings in Shell and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right. Authentication Tribe supports multiple authorization methods suitable for different scenarios. The two most common methods are: JWT Access Token Tribe Access Token JWT Access Token To authorize, use this code: # With shell, you can just pass the correct header with each request curl "api_endpoint_here" -H "Authorization: Bearer " Make sure to replace with your JWT access token. If your product's authentication already provides JWT access tokens, the easiest way is to use the same access token in Tribe. To do so, you need to install the "JWT Authorization" app from Tribe app store. Tribe supports JWKS and Public Key to validate the JWT access token. The JWT access token should include sub (The ID of user), name, iat (token issued time), and email. If the user already exists in Tribe it will perform the API request on behalf of the user. If the user does not exist, it will create the user based on the information in the JWT access token and performs the action on behalf of the new user. Tribe expects for the JWT access token to be included in API requests to the server in a header that looks like the following: Authorization: Bearer You must replace with the JWT access token. Tribe Access Token If your product does not support JWT access token or you are using Tribe as the main identity service, you need to first request for a client ID and client Secret by contacting us. Then, you'll be able to generate access token and refresh token using one of the following OAuth2 methods: The result for both POST requests will look like this: { "token_type": "bearer", "access_token": "", "expires_in": 31536000, "refresh_token": "" } To authorize, use this code: # With shell, you can just pass the correct header with each request curl "api_endpoint_here" -H "Authorization: Bearer " Make sure to replace with the generated access token. 1. Password Grant Type To get an access token for a user using their username/email and password you can use the password grant_type. This is useful when you want to authenticate user in a phone app or a custom login form, where user enters their username and password and you want to generate an access token for them. To do so, you should send a POST request to https://YOUR_COMMUNITY_URL/api/v1/oauth/token. It should include the following payload as application/x-www-form-urlencoded: Key Value grant_type password client_id The client ID provided by Tribe client_secret The client secret provided by Tribe username The username you want to authenticate with password The password you want to authenticate with 2. Tribe Custom Grant Type Tribe also have a custom grant_type called tribe:client_secret_credentials. With this grant type, you will be able to get the access_token and refresh_token for any user by their email, user_id (Tribe user id), or external_id (Your product's user_id that was passed in OAuth2 authentication). To do so, you should send a POST request to https://YOUR_COMMUNITY_URL/api/v1/oauth/token. It should include the following payload as application/x-www-form-urlencoded: Key Value grant_type tribe:client_secret_credentials client_id The client ID provided by Tribe client_secret The client secret provided by Tribe email, user_id or external_id The unique identifier of the user By default, this grant_type is open to all IP addresses, but for security reasons, we suggest that you give us a list of IP addresses and we'll limit it to those. Tribe expects the access token to be included in API requests to the server in a header that looks like the following: Authorization: Bearer You must replace with the generated access token. Answers Get All Answers curl "https://community.tribe.so/api/v1/answers" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "5bf0e89ada3be54c190b78ba", "updatedAt": "2018-12-03T22:20:11.069Z", "createdAt": "2018-11-18T04:20:42.892Z", "draftContent": "", "portal": "5a73b1fcc48071e4c4dc1cae", "question": { "_id": "5bf0e860da3be54c190b78b8", "shortId": "5okGL", "updatedAt": "2018-12-03T23:26:53.588Z", "createdAt": "2018-11-18T04:19:44.936Z", "title": "Can I embed external services (YouTube, Vimeo, etc.) in my answers or posts?", "user": { "_id": "5bacc9ff630b876a1e9785f7", "profile": { "counts": { "requests": 0, "edits": 0, "questionsFollowers": 0, "questions": 8, "comments": 0, "answersWords": 615, "answersVotes": 0, "answersViews": 0, "answers": 3, "views": 0, "followings": 0, "followers": 0 }, "score": 13, "externalId": null, "verified": false, "description": "", "title": "", "picture": "/files/users/5f7/5bacc9ff630b876a1e9785f7_15302.png", "website": "", "location": "", "gender": "", "name": "Robert D", "username": "robertd" }, "id": "5bacc9ff630b876a1e9785f7" }, "publishedAt": "2018-11-18T04:19:44.933Z", "portal": "5a73b1fcc48071e4c4dc1cae", "lastAskedAt": "2018-11-18T04:19:44.933Z", "actor": "5b1f99a7478dd3768d84b646", "__v": 1, "lastAnsweredAt": "2018-11-18T04:25:42.040Z", "referrers": [], "rewards": [], "hasReward": false, "downvotes": [], "upvotes": [], "followers": [], "askers": [], "comments": [], "topics": [ { "_id": "5b88264d3d9228aa7c41f692", "name": "Tribe", "user": { "_id": "5b881b2a90ecbe6751123d7e", "profile": { "counts": { "requests": 2, "edits": 148, "questionsFollowers": 0, "questions": 32, "comments": 0, "answersWords": 5753, "answersVotes": 0, "answersViews": 0, "answers": 31, "views": 0, "followings": 1, "followers": 2 }, "score": 115, "externalId": null, "verified": false, "description": "

", "title": "Tribe Moderator", "picture": "/files/users/646/5b1f99a7478dd3768d84b646_66172.png", "website": "", "location": "", "gender": "male", "name": "Siavash Mahmoudian", "username": "siavash" }, "id": "5b1f99a7478dd3768d84b646", "followed": false }, "__v": 1, "publishedAt": "2018-11-18T04:25:42.037Z", "shortId": "PEVpN", "downvotes": [], "upvotes": [ "5bc64d97a8c76d6d771ae914" ], "comments": [], "rewards": [], "images": [], "links": [], "score": 0, "global": true, "status": "published", "media": [], "counts": { "reasks": 0, "edits": 2, "downvotes": 0, "upvotes": 1, "comments": 0, "views": 34 }, "privacy": "public", "anonymous": false, "verified": false, "summary": "...", "id": "5bf0e89ada3be54c190b78ba", "upvoted": false, "downvoted": false, "intro": "..." } ] This endpoint retrieves all answers. HTTP Request GET /api/v1/answers Query Parameters Parameter Type Default Description page Number 1 Intended page limit Number 20 Number of items per page sort String createdAt.desc The field to sort on Get a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "_id": "5bf0e89ada3be54c190b78ba", "updatedAt": "2018-12-03T22:20:11.069Z", "createdAt": "2018-11-18T04:20:42.892Z", "draftContent": "", "portal": "5a73b1fcc48071e4c4dc1cae", "question": { "_id": "5bf0e860da3be54c190b78b8", "shortId": "5okGL", "updatedAt": "2018-12-03T23:26:53.588Z", "createdAt": "2018-11-18T04:19:44.936Z", "title": "Can I embed external services (YouTube, Vimeo, etc.) in my answers or posts?", "user": { "_id": "5bacc9ff630b876a1e9785f7", "profile": { "counts": { "requests": 0, "edits": 0, "questionsFollowers": 0, "questions": 8, "comments": 0, "answersWords": 615, "answersVotes": 0, "answersViews": 0, "answers": 3, "views": 0, "followings": 0, "followers": 0 }, "score": 13, "externalId": null, "verified": false, "description": "", "title": "", "picture": "/files/users/5f7/5bacc9ff630b876a1e9785f7_15302.png", "website": "", "location": "", "gender": "", "name": "Robert D", "username": "robertd" }, "id": "5bacc9ff630b876a1e9785f7" }, "publishedAt": "2018-11-18T04:19:44.933Z", "portal": "5a73b1fcc48071e4c4dc1cae", "lastAskedAt": "2018-11-18T04:19:44.933Z", "actor": "5b1f99a7478dd3768d84b646", "__v": 1, "lastAnsweredAt": "2018-11-18T04:25:42.040Z", "referrers": [], "rewards": [], "hasReward": false, "downvotes": [], "upvotes": [], "followers": [], "askers": [], "comments": [], "topics": [ { "_id": "5b88264d3d9228aa7c41f692", "name": "Tribe", "user": { "_id": "5b881b2a90ecbe6751123d7e", "profile": { "counts": { "requests": 2, "edits": 148, "questionsFollowers": 0, "questions": 32, "comments": 0, "answersWords": 5753, "answersVotes": 0, "answersViews": 0, "answers": 31, "views": 0, "followings": 1, "followers": 2 }, "score": 115, "externalId": null, "verified": false, "description": "

", "title": "Tribe Moderator", "picture": "/files/users/646/5b1f99a7478dd3768d84b646_66172.png", "website": "", "location": "", "gender": "male", "name": "Siavash Mahmoudian", "username": "siavash" }, "id": "5b1f99a7478dd3768d84b646", "followed": false }, "__v": 1, "publishedAt": "2018-11-18T04:25:42.037Z", "shortId": "PEVpN", "downvotes": [], "upvotes": [ "5bc64d97a8c76d6d771ae914" ], "comments": [], "rewards": [], "images": [], "links": [], "score": 0, "global": true, "status": "published", "media": [], "counts": { "reasks": 0, "edits": 2, "downvotes": 0, "upvotes": 1, "comments": 0, "views": 34 }, "privacy": "public", "anonymous": false, "verified": false, "summary": "...", "id": "5bf0e89ada3be54c190b78ba", "upvoted": false, "downvoted": false, "intro": "..." } This endpoint retrieves a specific answer using ID. HTTP Request GET /api/v1/answers/{id} URL Parameters Parameter Type Description id String The ID of the item Create an Answer curl "https://community.tribe.so/api/v1/questions/5c7bfc7a157c2c34f735a53e/answers" -X POST -H "Authorization: Bearer {access_token}" -H 'Content-Type: application/json; charset=utf-8' --DATA '{"content":""

Very good answer!

","anonymous": false,"status":"published"}' The above command returns JSON structured like this: { "_id": "5c7c04de68b07737dec0b39e", "updatedAt": "2019-03-03T16:49:29.077Z", "createdAt": "2019-03-03T16:46:22.281Z", "portal": "5c7bf24f157c2c34f735a539", "question": { "_id": "5c7bfc7a157c2c34f735a53e", "shortId": "5ogL5", "lang": "en", "updatedAt": "2019-03-03T16:47:35.149Z", "createdAt": "2019-03-03T16:10:34.005Z", "title": "My anonymous question", "publishedAt": "2019-03-03T16:10:34.003Z", "portal": "5c7bf24f157c2c34f735a539", "lastAskedAt": "2019-03-03T16:10:34.003Z", "user": { "_id": "5c7bf251157c2c34f735a53a", "profile": { "counts": { "requests": 0, "edits": 1, "questionsFollowers": 0, "questions": 2, "comments": 0, "answersWords": 3, "answersVotes": 0, "answersViews": 0, "answers": 1, "views": 0, "followings": 0, "followers": 0 }, "score": 10, "verified": false, "description": "", "title": "", "picture": "https://gravatar.com/avatar/b7711ecd91aebb5dd1b7c153dbfd92d0?s=200&d=retro", "website": "", "location": "", "gender": "", "name": "Admin", "username": "admin" }, "id": "5c7bf251157c2c34f735a53a" }, "__v": 1, "lastAnsweredAt": "2019-03-03T16:47:35.149Z", "referrers": [], "rewards": [], "hasReward": false, "downvotes": [], "upvotes": [], "followers": [], "askers": [], "comments": [], "topics": [ { "_id": "5c7bff4bc389b77bdf1f2726", "name": "test", "user": { "_id": "5c7bf251157c2c34f735a53a", "profile": { "counts": { "requests": 0, "edits": 1, "questionsFollowers": 0, "questions": 2, "comments": 0, "answersWords": 3, "answersVotes": 0, "answersViews": 0, "answers": 1, "views": 0, "followings": 0, "followers": 0 }, "score": 10, "verified": false, "description": "", "title": "", "picture": "https://gravatar.com/avatar/b7711ecd91aebb5dd1b7c153dbfd92d0?s=200&d=retro", "website": "", "location": "", "gender": "", "name": "Admin", "username": "admin" }, "id": "5c7bf251157c2c34f735a53a" }, "id": "5c7bff4bc389b77bdf1f2726" } ], "score": 0, "status": "published", "counts": { "asks": 1, "downvotes": 0, "upvotes": 0, "edits": 2, "comments": 0, "hiddenAnswers": 0, "answers": 2, "views": 1, "followers": 0 }, "type": "general", "privacy": "public", "anonymous": false, "verified": false, "locked": false, "id": "5c7bfc7a157c2c34f735a53e" }, "user": { "_id": "5c7c00dd68b07737dec0b39a", "profile": { "counts": { "requests": 0, "edits": 2, "questionsFollowers": 0, "questions": 0, "comments": 0, "answersWords": 3, "answersVotes": 0, "answersViews": 0, "answers": 1, "views": 0, "followings": 0, "followers": 0 }, "score": 10, "verified": false, "description": "", "title": "", "picture": "https://gravatar.com/avatar/a6ac5b09b633aafba41b4a0cda22976e?s=200&d=retro", "website": "", "location": "", "gender": "", "name": "Amir", "username": "triplea1373" }, "id": "5c7c00dd68b07737dec0b39a" }, "__v": 0, "content": "

Very good answer!A

", "draftContent": "", "publishedAt": "2019-03-03T16:47:35.147Z", "shortId": "yJ1pQ", "downvotes": [], "upvotes": [], "comments": [], "rewards": [], "images": [], "links": [], "score": 0, "global": true, "status": "published", "media": [], "counts": { "reasks": 0, "edits": 3, "downvotes": 0, "upvotes": 0, "comments": 0, "views": 1 }, "privacy": "public", "anonymous": false, "verified": false, "summary": "Very good answer!A", "id": "5c7c04de68b07737dec0b39e", "upvoted": false, "downvoted": false } The endpoint creates an answer for a specific question. HTTP Request POST /api/v1/questions/:questionId/answers URL Parameters Parameter Type Description questionId String The ID of the question Request Parameters Parameter Type Description content String The content of the answer anonymous Boolean Is it an anonymous answer or not status String Status of the answer. Can be: archived collapsed draft published unapproved unlisted scheduled new Extra Request Parameters for Moderators Parameter Type Description verified Boolean Is this answer verified or not user String The ID of the user to create an answer on behalf Answer a poll curl "https://community.tribe.so/api/v1/answers/5e3d8df499d91a48d101d8e2/poll" -X POST -H "Authorization: Bearer {access_token}" -H 'Content-Type: application/json; charset=utf-8' --DATA '{"poll":"5e3d8df499d91a48d101d8e4"}' The endpoint creates a poll answer for a specific question. HTTP Request POST /api/v1/answers/:questionId/poll URL Parameters Parameter Type Description questionId String The ID of the question Request Parameters Parameter Type Description poll String ID of the selected poll option Update a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba" -X PUT -H "Authorization: Bearer {access_token}" -H 'Content-Type: application/json; charset=utf-8' --DATA '{"content":"Test answer","anonymous": false,"status":"published"}' This endpoint update a specific answer. HTTP Request PUT /api/v1/answers/{id} URL Parameters Parameter Type Description id String The ID of the answer to update Request Parameters Parameter Type Description content String The content of the answer anonymous String Is it an anonymous answer or not Extra Request Parameters for Moderators Parameter Type Description verified String Is this a verified answer or not status String Status of the answer. Can be: archived collapsed draft published unapproved unlisted scheduled new Delete a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint deletes a specific answer. HTTP Request DELETE /api/v1/answers/{id} URL Parameters Parameter Type Description id String The ID of the answer to delete Delete a Specific Draft Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba/draft" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint deletes a specific draft answer. HTTP Request DELETE /api/v1/answers/{id}/draft URL Parameters Parameter Type Description id String The ID of the answer to delete Upvote a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba/votes" -X POST -H "Authorization: Bearer {access_token}" This endpoint upvotes for a specific answer. HTTP Request POST /api/v1/answers/:id/votes URL Parameters Parameter Type Description id String The ID of the answer to add a vote Remove Upvote for a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba/votes" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint removes an upvote for a specific answer. HTTP Request DELETE /api/v1/answers/:id/votes URL Parameters Parameter Type Description id String The ID of the answer to remove a vote Get List of Votes for a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba/votes" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "upvotes": [ { "_id": "5bc64d97a8c76d6d771ae914", "profile": { "title": "Customer Success @Tribe", "picture": "https://gravatar.com/avatar/1ec94547651bb4e27ce2bdd0113f7487?s=200&d=retro", "name": "Mo Malayeri", "username": "mo11832" }, "id": "5bc64d97a8c76d6d771ae914" }, { "_id": "5b881b2a90ecbe6751123d7e", "profile": { "title": "Community Manager at Tribe", "picture": "/files/users/d7e/5b881b2a90ecbe6751123d7e_88402.png", "name": "Eli Najafi", "username": "elnaz" }, "id": "5b881b2a90ecbe6751123d7e" }, { "_id": "5b912f01f19a473232026862", "profile": { "title": "Marketing Manager", "picture": "/files/users/862/5b912f01f19a473232026862_29979.png", "name": "Melanie Jones", "username": "mike2" }, "id": "5b912f01f19a473232026862" }, { "_id": "5bacc9ff630b876a1e9785f7", "profile": { "title": "", "picture": "/files/users/5f7/5bacc9ff630b876a1e9785f7_15302.png", "name": "Robert D", "username": "robertd" }, "id": "5bacc9ff630b876a1e9785f7" }, { "_id": "5ba95b5c630b876a1e9785a5", "profile": { "title": "Community Manager at BHD", "picture": "/files/users/5a5/5ba95b5c630b876a1e9785a5_41926.png", "name": "Eddie Reid", "username": "ereid" }, "id": "5ba95b5c630b876a1e9785a5" }, { "_id": "5b8ff4190607d4174e2eb73b", "profile": { "title": "Community Moderator at Acondo", "picture": "/files/users/73b/5b8ff4190607d4174e2eb73b_29849.png", "name": "Kenneth Jensen", "username": "mike1" }, "id": "5b8ff4190607d4174e2eb73b" } ], "downvotes": [] } This endpoint retrieves all answers for a specific answer. HTTP Request GET /api/v1/answers/:id/votes URL Parameters Parameter Type Description id String The ID of the answer to receive the votes Add a Comment for a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba/comments" -X POST -H "Authorization: Bearer {access_token}" --DATA "{'body':'New comment'}" This endpoint adds a comment for a specific answer. HTTP Request POST /api/v1/answers/:id/comments URL Parameters Parameter Type Description id String The ID of the answer to add a comment Request Parameters Parameter Type Description body String The content of the comment Extra Request Parameters for Moderators Parameter Type Description user String The ID of the user to comment on behalf Update a Specific Comment for a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba/comments/4sf0e89ada3be54c190b78b2" -X PUT -H "Authorization: Bearer {access_token}" --DATA "{'body':'Updated comment'}" This endpoint updates a specific comment. HTTP Request PUT /api/v1/answers/:answerId/comments/:id URL Parameters Parameter Type Description id String The ID of the comment to update answerId String The ID of the answer to add a comment Request Parameters Parameter Type Description body String The content of the comment Remove a Specific Comment from a Specific Answer curl "https://community.tribe.so/api/v1/answers/5bf0e89ada3be54c190b78ba/comments/4sf0e89ada3be54c190b78b2" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint removes a specific comment. HTTP Request DELETE /api/v1/answers/:answerId/comments/:id URL Parameters Parameter Type Description id String The ID of the comment to remove answerId String The ID of the answer to remove a comment Add Log for Specific Answers curl "https://community.tribe.so/api/v1/answers/logs" -X POST -H "Authorization: Bearer {access_token}" --DATA '{ ids: ["5bf0e89ada3be54c190b78ba"] }' The above command returns JSON structured like this: { "success": true } This endpoint adds a log for a specific answer. HTTP Request POST /api/v1/answers/logs Request Parameters Parameter Type Description logs Array The ID of answers to add log Get Stats of Specific User for Answers curl "https://community.tribe.so/api/v1/user/stats/answers/views" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "values": { "2019-02-10": 0, "2019-02-11": 0, "2019-02-12": 0, "2019-02-13": 0, "2019-02-14": 0, "2019-02-15": 0, "2019-02-16": 0, "2019-02-17": 0, "2019-02-18": 0, "2019-02-19": 0, "2019-02-20": 0, "2019-02-21": 0, "2019-02-22": 0, "2019-02-23": 0, "2019-02-24": 0, "2019-02-25": 0, "2019-02-26": 0, "2019-02-27": 0, "2019-02-28": 0, "2019-03-01": 0, "2019-03-02": 0, "2019-03-03": 0, "2019-03-04": 0, "2019-03-05": 0, "2019-03-06": 0, "2019-03-07": 0, "2019-03-08": 0, "2019-03-09": 0, "2019-03-10": 0, "2019-03-11": 0, "2019-03-12": 0, "2019-03-13": 0 }, "type": "user_answer_viewed", "timestamp": "2019-03-01" } This endpoint returns statistics of a specific user for answers. HTTP Request GET /api/v1/user/stats/answers/:metric Request Parameters Parameter Type Description metric String Metric for the statistics. Can be views,votes,follows Reporting a Specific Answer curl "https://community.tribe.so/api/v1/answers/5a816275f8030b3bdd655b0d/reports" -X POST -H "Authorization: Bearer {access_token}" This endpoint reports (flags) a specific answer to admins and moderators. HTTP Request POST /api/v1/answers/:id/reports URL Parameters Parameter Type Description id String The ID of the answer to report Query Parameters Parameter Type Description type String The type of the report. Can be Harrasment, Spam, DoesntAnswerQuestion, Plagiarism, JokeAnswer, OutOfDate, PoorlyWritten, FactuallyIncorrect, or AgainstRules description String The optional description of the report shown to admins and moderators Comments Update a Specific Comment curl "https://community.tribe.so/api/v1/comments/5c0621864cb2b119dc174a63" -X PUT -H "Authorization: Bearer {access_token}" --DATA "{data}" This endpoint updates a specific comment. HTTP Request PUT /api/v1/comments/:id URL Parameters Parameter Type Description id String The ID of the comment to update Request Parameters Parameter Type Description body String The content of the comment Delete a Specific Comment curl "https://community.tribe.so/api/v1/comments/5c0621864cb2b119dc174a63" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint deletes a specific comment. HTTP Request DELETE /api/v1/comments/{id} URL Parameters Parameter Type Description id String The ID of the comment to delete Upvote for a Specific Comment curl "https://community.tribe.so/api/v1/comments/5c0621864cb2b119dc174a63/votes" -X POST -H "Authorization: Bearer {access_token}" This endpoint upvotes a specific comment. HTTP Request POST /api/v1/comments/{id}/votes URL Parameters Parameter Type Description id String The ID of the comment to upvote Remove an Upvote for a Specific Comment curl "https://community.tribe.so/api/v1/comments/5c0621864cb2b119dc174a63/votes" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint removes an upvote a specific comment. HTTP Request DELETE /api/v1/comments/{id}/votes URL Parameters Parameter Type Description id String The ID of the comment to remove an upvote Reporting a Specific Comment curl "https://community.tribe.so/api/v1/comments/5a816275f8030b3bdd655b0d/reports" -X POST -H "Authorization: Bearer {access_token}" This endpoint reports (flags) a specific comment to admins and moderators. HTTP Request POST /api/v1/comments/:id/reports URL Parameters Parameter Type Description id String The ID of the comment to report Query Parameters Parameter Type Description type String The type of the report. Can be Harrasment, Spam, Plagiarism, JokeComment, OutOfDate, PoorlyWritten, FactuallyIncorrect, or AgainstRules description String The optional description of the report shown to admins and moderators Feed Get User Feed curl "https://community.tribe.so/api/v1/feed" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "topics-1", "type": "Topics", "topics": [ ... ], "description": "You have not picked any topics yet. Please pick some to improve this page." }, { "_id": "5c0621864cb2b119dc174a63", "type": "Discussion", "publishedAt": "2018-12-04T06:41:10.031Z", "post": { ... } }, { "_id": "5bf0e89ada3be54c190b78ba", "type": "Answer", "publishedAt": "2018-11-18T04:25:42.037Z", "answer": { ... } } ] This endpoint retrieves user feed. HTTP Request GET /api/v1/feed Query Parameters Parameter Type Default Description type String Comma separated list of types to filter on. Types can be post, question, discussion, and article page Number 1 Intended page limit Number 20 Number of items per page sort String createdAt.desc The field to sort on Notification Get User Notification curl "https://community.tribe.so/api/v1/notifications" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "5bf2ac9b86eb922c246e77ca", "emailAt": "2018-11-19T12:29:15.723Z", "updatedAt": "2018-11-19T12:29:15.722Z", "createdAt": "2018-11-19T12:29:15.722Z", "verb": "follow_user", "to": "5b1f99a7478dd3768d84b646", "__v": 0, "emailSent": false, "read": false, "objects": [], "from": [ { "_id": "5bd164051f117e0440efb07c", "profile": { "picture": "https://gravatar.com/avatar/533db9190e9912306ed3334e3dba2a56?s=200&d=retro", "name": "Sayle", "username": "sayele" }, "id": "5bd164051f117e0440efb07c" } ] }, { "_id": "5bf210a61c546252b2d79030", "updatedAt": "2018-11-19T01:23:50.998Z", "createdAt": "2018-11-19T01:23:50.998Z", "verb": "upvote", "to": "5b1f99a7478dd3768d84b646", "__v": 0, "emailSent": false, "read": false, "objects": [ { ... } ], "from": [ { "_id": "5bd9d35ad242f810e3d84ab6", "profile": { "picture": "/files/users/ab6/5bd9d35ad242f810e3d84ab6_77365.png", "name": "Soheil Alavi", "username": "soheil" }, "id": "5bd9d35ad242f810e3d84ab6" } ] }, { "_id": "5be36b573fb95035bf9085a5", "emailAt": "2018-11-07T22:46:47.681Z", "updatedAt": "2018-11-07T22:46:47.679Z", "createdAt": "2018-11-07T22:46:47.679Z", "verb": "ask", "to": "5b1f99a7478dd3768d84b646", "__v": 0, "emailSent": false, "read": false, "objects": [ { "_id": "5be36b573fb95035bf9085a3", "shortId": "QrmZ6", "updatedAt": "2018-11-22T22:09:56.432Z", "createdAt": "2018-11-07T22:46:47.522Z", "title": "What is Tribe's Privacy Policy?", "publishedAt": "2018-11-07T22:46:47.519Z", "portal": "5a73b1fcc48071e4c4dc1cae", "lastAskedAt": "2018-11-07T22:46:47.519Z", "actor": "5b3f7fe0d5a11b6297259cab", "__v": 2, "lastAnsweredAt": "2018-11-07T22:47:16.105Z", "referrers": [ { "type": "social", "source": "facebook", "count": 1, "_id": "5be36fa23fb95035bf9085a8", "urls": [] } ], "rewards": [], "hasReward": false, "askers": [], "score": 0, "status": "published", "type": "general", "privacy": "public", "anonymous": false, "verified": false, "locked": false, "id": "5be36b573fb95035bf9085a3" } ], "from": [ { "_id": "5b913111f19a473232026877", "profile": { "picture": "/files/users/877/5b913111f19a473232026877_65884.png", "name": "Adrian Garcia", "username": "adriang" }, "id": "5b913111f19a473232026877" } ] } ] This endpoint retrieves user notifications. HTTP Request GET /api/v1/notifications Query Parameters Parameter Type Default Description page Number 1 Intended page limit Number 20 Number of items per page Get User Notification Summary curl "https://community.tribe.so/api/v1/notifications/summary" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "count": "19" } This endpoint retrieves user notifications count. HTTP Request GET /api/v1/notifications/summary Mark All Notifications as Read curl "https://community.tribe.so/api/v1/notifications/summary" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint marks all user notifications as read. HTTP Request POST /api/v1/notifications/read Mark a Specific Notification as Read curl "https://community.tribe.so/api/v1/notifications/5b913111f19a473232026877/read" -X POST -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint marks a specific notification as read. HTTP Request POST /api/v1/notifications/:id/read URL Parameters Parameter Type Description id String The ID of the notification to mark as read Firebase Notification curl "https://community.tribe.so/api/v1/user/devices" -X POST -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } If you are using Firebase app, you can receive the firebase notification on user devices. After installing the app, you should paste your JSON configuration file in the app's settings section. You must include inside the JSON. After finishing the configuration, you need you need to register the device tokens. HTTP Request This endpoint register the token to a specific user. POST /api/v1/user/devices URL Parameters Parameter Type Description type String Type of the device. It can be android, ios token String The device token to register name String Name associated to the device HTTP Request This endpoint discards the token from a specific user. DELETE /api/v1/user/devices URL Parameters Parameter Type Description token String The device token to discard Notification Object The notification object you receive in the device have the following structure. Key Value title Name of the portal body Message of the notification name Name of the user icon Icon of the notification url URL associated with the notification tag A static string with notification as value Portal Get Portal Information curl "https://community.tribe.so/api/v1/portal" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "_id": "5a73b1fcc48071e4c4dc1cae", "updatedAt": "2018-11-30T00:46:42.809Z", "createdAt": "2018-02-02T02:13:32.692Z", "name": "Tribe", "domain": "community.tribe.so", "baseUrl": "https://community.tribe.so", "moderators": [], "admins": [], "__v": 9, "englishName": "Tribe", "description": "Tribe is a cloud-based community platform that plugs into your marketing stack. Integrated with your social media, it helps you amplify the vibe around your business by allowing you and your customers to create content.", "keywords": "", "longName": "Tribe, a cloud based community platform", "favicon": "/files/portals/cae/favicon_19357.png", "logo": "/files/portals/cae/logo_59518.png", "banner": "/files/portals/cae/banner_96419.png", "apps": [], "announcement": { "title": "Forums are dead. Build your tribe.", "picture": "/files/portals/cae/announcement_79671.png", "link": "https://tribe.so/#request-form", "enabled": true, "content": "

Tribe is a cloud-based community platform that plugs into your marketing stack. Integrated with your social media, it helps you amplify the vibe around your business by allowing you and your customers to create content.

", "action": "Request Demo", "layout": "imageSidePadded" }, "template": { "sidebar": "", "head": "", "css": "", "body": "", "menu": { "height": 65 }, "navbar": { "links": [ { "_id": "5bf2400486eb922c246e77c5", "url": "https://tribe.so/features", "text": "Features", "position": "start" }, { "_id": "5bf2400486eb922c246e77c4", "url": "https://tribe.so/services", "text": "Services", "position": "start" }, { "_id": "5bf2400486eb922c246e77c3", "url": "https://tribe.so/#pricing", "text": "Pricing", "position": "start" }, { "_id": "5bf2400486eb922c246e77c2", "url": "https://tribe.so/app-store", "text": "App Store", "position": "start" } ], "enabled": true, "linksString": "Features | https://tribe.so/features | start\nServices | https://tribe.so/services | start\nPricing | https://tribe.so/#pricing | start\nApp Store | https://tribe.so/app-store | start" }, "colors": { "primary": "#26c964" }, "theme": "default" }, "messages": { "motto": "Join the community of community managers!" }, "featured": { "posts": [], "events": [], "answers": [ "5babcf33630b876a1e9785cd" ], "topics": [ "5b912fcb3d9228aa7c4220dc", "5b9002da3d9228aa7c421ec4", "5b912f963d9228aa7c4220db", "5b8ffc353d9228aa7c421eb1", "5b9ad5883d9228aa7c422f0c", "5b88264d3d9228aa7c41f692" ], "users": [], "questions": [] }, "links": { "twitter": "", "telegram": "", "privacy": "/question/5be36b573fb95035bf9085a3", "linkedin": "", "instagram": "", "faq": "", "facebook": "" }, "currency": { "external": { "name": "CAD" }, "conversionRate": 1, "internal": { "name": "Coin" }, "enabled": true }, "counts": { "unapprovedAnswers": 0, "unapprovedQuestions": 0, "comments": 0, "unanswered": 25, "topics": 30, "answers": 72, "questions": 91, "users": 28 }, "sections": [], "policies": { "cookieConsent": "enabled", "registration": "public", "content": "shareable", "access": "public" }, "stage": "inception", "status": "live", "type": "root", "plan": "basic", "topics": [ { "_id": "5b9ad5883d9228aa7c422f0c", "name": "Online Community", "user": { "_id": "5b881b2a90ecbe6751123d7e", "profile": { "counts": { "requests": 2, "edits": 148, "questionsFollowers": 0, "questions": 32, "comments": 0, "answersWords": 5753, "answersVotes": 0, "answersViews": 0, "answers": 31, "views": 0, "followings": 1, "followers": 2 }, "score": 115, "externalId": null, "verified": false, "description": "

", "title": "Biomedical Engineer ", "picture": "/files/users/d7e/5b881b2a90ecbe6751123d7e_57697.png", "website": "", "location": "", "gender": "", "name": "Elnaz Najafi", "username": "elnajafi89" }, "id": "5b881b2a90ecbe6751123d7e" }, "picture": "/files/topics/c66/5babe5eb3d9228aa7c423c66_66024.png", "id": "5babe5eb3d9228aa7c423c66" } ], "aliases": [], "id": "5a73b1fcc48071e4c4dc1cae", "updateHash": "c7bc3e38df948c7342f9e6b41d817136" } This endpoint retrieves portal information. HTTP Request GET /api/v1/portal Get Portal Health Stats curl "https://community.tribe.so/api/v1/stats/portal" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "usersActions": 220, "usersPosts": 132, "usersSeen": 359, "user": { "lastSeenAt": "a few seconds ago", "lastActionAt": "7 minutes ago", "lastPostAt": "7 minutes ago" } } This endpoint retrieves portal health stats. HTTP Request GET /api/v1/stats/portal Get Portal Leaderboard curl "https://community.tribe.so/api/v1/stats/users/leaderboard" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "target": { "_id": "5b881b2a90ecbe6751123d7e", "profile": { "counts": { "requests": 2, "edits": 148, "questionsFollowers": 0, "questions": 32, "comments": 0, "answersWords": 5753, "answersVotes": 0, "answersViews": 0, "answers": 31, "views": 0, "followings": 1, "followers": 2 }, "score": 115, "externalId": null, "verified": false, "description": "", "title": "Biomedical Engineer ", "picture": "/files/users/d7e/5b881b2a90ecbe6751123d7e_57697.png", "website": "", "location": "", "gender": "", "name": "Elnaz Najafi", "username": "elnajafi89" }, "id": "5b881b2a90ecbe6751123d7e", "followed": true }, "total": 115 }, { "target": { "_id": "5b7625c6307b5967d06481fb", "profile": { ... } }, "total": 10 }, { "target": { "_id": "5b7de7d02234e67f52e900cf", "profile": { ... } }, "total": 10 } ] This endpoint retrieves users leaderboard in portal. HTTP Request GET /api/v1/stats/users/leaderboard Update the Portal curl "https://community.tribe.so/api/v1/portal" -X PUT -H "Authorization: Bearer {access_token}" --DATA '{"name": "Test Portal","domain":"test.com"}' This endpoint updates the portal. HTTP Request PUT /api/v1/portal Request Parameters Parameter Type Description Required name String The name of the portal Yes domain String The domain of the portal Yes subdomain String The subdomain of the portal No announcement Object The announcement visible to all users on the homepage. No banner String The path to the banner image. This image is used as the default og:image. No description String Description of the portal No email String Email of the portal No englishName String Name of the portal in English No favicon String Icon of the portal No keywords Array Keywords related to the portal No links Object Community links used in the sidebar and emails. No logo String Logo of the portal No longName String The full name of the community. This is being used as the title of community home. No messages String Custom messages for the community. No policies Object Policies of community. No stage String Define the stage of the community. Can be: inceptionestablishmentmaturitymitosis. No template Object Template of the portal No Announcement Parameters Parameter Type Description action String The action button text content String Content of the announcement enabled String Is announcement enabled? layout String The layout of the announcement. Can be: imageTopimageSideimageSidePaddedimageBackgroundimageTopBackgrounddarkImageBackground link String Link related to the announcement picture String Url to the picture of the announcement title String Title of the announcement Links Parameters Parameter Type Description bug String Name of the holder facebook String Facebook handle of the portal faq String FAQ url of the portal feature String Request for feature url. homepage String Homepage of the portal instagram String Instagram handle of the portal linkedin String Linkedin handle of the portal privacy String Url to portal's privacy policy telegram String Telegram handle of the portal terms String Url to portal's terms and condition twitter String Twitter handle of the portal Messages Parameters Parameter Type Description askRules String Rules of asking questions motto String Motto of the portal questionIntro String Introduction for questions signupRules String Rules of signing up topicIntro String Introduction for topics userIntro String Introduction for users Template Parameters Parameter Type Description body String Body tag of the template colors.default String Default Color colors.defaultLink String Default link colors.link String Color of links colors.menuLink String Color of menu colors.primary String Primary Color colors.secondary String Secondary Color css String Custom CSS appended to the end of the code as style tag. menu.background String Background Color of menu menu.border Number Border size of the menu menu.height Number Border height of the menu navbar.background String Background Color of the navigation bar navbar.border Number Border size of the navigation bar navbar.color String Color of the navigation bar navbar.enabled Boolean Is navigation bar enabled? navbar.height Number Height the navigation bar navbar.links Array Links of the navigation bar navbar.linksString String Links of the navigation bar in String format. sidebar String The HTML code used inside the sidebar box. Policies Parameters Parameter Type Description access String Access privacy of the community. Can be: public, private. cookieConsent String Display cookie consent? Can be: enabled, disabled. email String Defines the types of emails to be sent from the community. Can be: important, disabled, enabled. registration String The registration policy of the community. Can be: public, approval, invitation. Install an App curl "https://community.tribe.so/api/v1/apps/5c7ff860c389b77bdf1f272b/settings" -X POST -H "Authorization: Bearer {access_token}" -H 'Content-Type: application/json; charset=utf-8' The above command returns JSON structured like this: { "_id": "5c7bf24f157c2c34f735a539", "updatedAt": "2019-03-13T14:11:32.761Z", "createdAt": "2019-03-03T15:27:11.190Z", "name": "Tribe", "baseUrl": "https://community.tribe.so", "description": "", "domain": "tribe.so", "__v": 7, "apps": [ { "app": { "_id": "5c8635bac389b77bdf1f2732", "slug": "moderation", "updatedAt": "2019-03-13T14:10:03.311Z", "name": "Moderation", "shortDescription": "Let admins create a minimum reptation.", "picture": "https://tribe.so/assets/images/appstore/jwt-sso.png", "__v": 0, "createdAt": "2019-03-11T10:17:25.732Z", "settings": { "user": [], "portal": [ { "type": "checkbox", "name": "enabled", "_id": "5c890f3b1ff360189a3d038e", "private": false, "values": [] }, { "type": "number", "name": "minimumReputation", "_id": "5c890f3b1ff360189a3d038d", "private": true, "values": [] } ] }, "components": { "settings": "Moderation" }, "permissions": [], "active": true, "premium": false, "followers": [], "counts": { "followers": 0, "installs": 0 }, "screenshots": [], "categories": [ "Functionality" ], "author": { "link": "https://tribe.so", "name": "Tribe Technologies, Inc" }, "type": "native", "id": "5c8635bac389b77bdf1f2732" }, "slug": "moderation", "settings": { "minimumReputation": "8", "_id": "5c8635bac389b77bdf1f2732", "enabled": true }, "_id": "5c864854f6e41f201083bf60", "enabled": false }, { "app": { "_id": "5c7bf24fc389b77bdf1f271f", "name": "Welcome Email", "updatedAt": "2019-03-13T14:10:03.304Z", "shortDescription": "Send an automatic customized welcome email to new users.", "slug": "welcome-email", "picture": "https://tribe.so/assets/images/appstore/welcome-email.png", "__v": 0, "createdAt": "2019-03-03T15:27:07.020Z", "settings": { "user": [], "portal": [ { "type": "checkbox", "name": "enabled", "_id": "5c890f3b1ff360189a3d0378", "private": false, "values": [] }, { "type": "text", "name": "fromEmail", "_id": "5c890f3b1ff360189a3d0377", "private": true, "values": [] }, { "type": "text", "name": "fromName", "_id": "5c890f3b1ff360189a3d0376", "private": true, "values": [] }, { "type": "text", "name": "subject", "_id": "5c890f3b1ff360189a3d0375", "private": true, "values": [] }, { "type": "text", "name": "message", "_id": "5c890f3b1ff360189a3d0374", "private": true, "values": [] } ] }, "components": { "settings": "WelcomeEmail" }, "permissions": [], "active": true, "premium": false, "followers": [], "counts": { "followers": 0, "installs": 0 }, "screenshots": [], "categories": [ "Functionality" ], "author": { "link": "https://tribe.so", "name": "Tribe Technologies, Inc" }, "type": "native", "id": "5c7bf24fc389b77bdf1f271f" }, "slug": "welcome-email", "settings": { "_id": "5c7bf24fc389b77bdf1f271f" }, "_id": "5c864865f6e41f201083bf61", "enabled": false }, { "app": { "_id": "5c7ff860c389b77bdf1f272b", "name": "SendGrid", "updatedAt": "2019-03-13T14:10:03.305Z", "shortDescription": "Send emails from your SendGrid account resulting in better email delivery.", "slug": "sendgrid", "picture": "https://tribe.so/assets/images/appstore/sendgrid.png", "__v": 0, "createdAt": "2019-03-06T16:42:05.969Z", "settings": { "user": [], "portal": [ { "type": "checkbox", "name": "enabled", "_id": "5c890f3b1ff360189a3d037b", "private": false, "values": [] }, { "type": "text", "name": "username", "_id": "5c890f3b1ff360189a3d037a", "private": true, "values": [] }, { "type": "text", "name": "password", "_id": "5c890f3b1ff360189a3d0379", "private": true, "values": [] } ] }, "components": { "settings": "SendGrid" }, "permissions": [], "active": true, "premium": false, "followers": [], "counts": { "followers": 0, "installs": 0 }, "screenshots": [], "categories": [ "Functionality" ], "author": { "link": "https://tribe.so", "name": "Tribe Technologies, Inc" }, "type": "native", "id": "5c7ff860c389b77bdf1f272b" }, "slug": "sendgrid", "settings": { "_id": "5c7ff860c389b77bdf1f272b" }, "_id": "5c890f941ff360189a3d038f", "enabled": false } ], "secrets": { "ssoKey": "1f4f219a4b525ddfaba64a54f997e226353726720b477c7c" }, "announcement": { "layout": "imageSide" }, "template": { "navbar": { "links": [], "enabled": false, "linksString": "" }, "theme": "default" }, "featured": { "posts": [], "events": [], "answers": [], "topics": [], "users": [], "questions": [] }, "currency": { "conversionRate": 100, "enabled": false }, "counts": { "unapprovedAnswers": 0, "unapprovedQuestions": 0, "comments": 0, "unanswered": 0, "topics": 0, "answers": 0, "questions": 0, "users": 0 }, "sections": [], "policies": { "email": "enabled", "cookieConsent": "disabled", "registration": "public", "content": "shareable", "access": "public" }, "stage": "inception", "status": "live", "type": "general", "plan": "basic", "topics": [], "aliases": [], "corsWhitelist": [], "id": "5c7bf24f157c2c34f735a539", "updateHash": "1473a306957af1b78b580c0d4cf896ff" } The endpoint installs an app in the portal. HTTP Request POST /api/v1/apps/:id/settings URL Parameters Parameter Type Description id String The ID of app to install Uninstall an App curl "https://community.tribe.so/api/v1/apps/5c7ff860c389b77bdf1f272b/settings" -X DELETE -H "Authorization: Bearer {access_token}" -H 'Content-Type: application/json; charset=utf-8' The above command returns JSON structured like this: { "_id": "5c7bf24f157c2c34f735a539", "updatedAt": "2019-03-13T14:15:04.709Z", "createdAt": "2019-03-03T15:27:11.190Z", "name": "Tribe", "baseUrl": "https://community.tribe.so", "description": "", "domain": "tribe.so", "__v": 8, "apps": [ { "app": { "_id": "5c8635bac389b77bdf1f2732", "slug": "moderation", "updatedAt": "2019-03-13T14:10:03.311Z", "name": "Moderation", "shortDescription": "Let admins create a minimum reptation.", "picture": "https://tribe.so/assets/images/appstore/jwt-sso.png", "__v": 0, "createdAt": "2019-03-11T10:17:25.732Z", "settings": { "user": [], "portal": [ { "type": "checkbox", "name": "enabled", "_id": "5c890f3b1ff360189a3d038e", "private": false, "values": [] }, { "type": "number", "name": "minimumReputation", "_id": "5c890f3b1ff360189a3d038d", "private": true, "values": [] } ] }, "components": { "settings": "Moderation" }, "permissions": [], "active": true, "premium": false, "followers": [], "counts": { "followers": 0, "installs": 0 }, "screenshots": [], "categories": [ "Functionality" ], "author": { "link": "https://tribe.so", "name": "Tribe Technologies, Inc" }, "type": "native", "id": "5c8635bac389b77bdf1f2732" }, "slug": "moderation", "settings": { "enabled": true, "_id": "5c8635bac389b77bdf1f2732", "minimumReputation": "8" }, "_id": "5c864854f6e41f201083bf60", "enabled": false }, { "app": { "_id": "5c7bf24fc389b77bdf1f271f", "name": "Welcome Email", "updatedAt": "2019-03-13T14:10:03.304Z", "shortDescription": "Send an automatic customized welcome email to new users.", "slug": "welcome-email", "picture": "https://tribe.so/assets/images/appstore/welcome-email.png", "__v": 0, "createdAt": "2019-03-03T15:27:07.020Z", "settings": { "user": [], "portal": [ { "type": "checkbox", "name": "enabled", "_id": "5c890f3b1ff360189a3d0378", "private": false, "values": [] }, { "type": "text", "name": "fromEmail", "_id": "5c890f3b1ff360189a3d0377", "private": true, "values": [] }, { "type": "text", "name": "fromName", "_id": "5c890f3b1ff360189a3d0376", "private": true, "values": [] }, { "type": "text", "name": "subject", "_id": "5c890f3b1ff360189a3d0375", "private": true, "values": [] }, { "type": "text", "name": "message", "_id": "5c890f3b1ff360189a3d0374", "private": true, "values": [] } ] }, "components": { "settings": "WelcomeEmail" }, "permissions": [], "active": true, "premium": false, "followers": [], "counts": { "followers": 0, "installs": 0 }, "screenshots": [], "categories": [ "Functionality" ], "author": { "link": "https://tribe.so", "name": "Tribe Technologies, Inc" }, "type": "native", "id": "5c7bf24fc389b77bdf1f271f" }, "slug": "welcome-email", "settings": { "_id": "5c7bf24fc389b77bdf1f271f" }, "_id": "5c864865f6e41f201083bf61", "enabled": false } ], "secrets": { "ssoKey": "1f4f219a4b525ddfaba64a54f997e226353726720b477c7c" }, "announcement": { "layout": "imageSide" }, "template": { "navbar": { "links": [], "enabled": false, "linksString": "" }, "theme": "default" }, "featured": { "posts": [], "events": [], "answers": [], "topics": [], "users": [], "questions": [] }, "currency": { "conversionRate": 100, "enabled": false }, "counts": { "unapprovedAnswers": 0, "unapprovedQuestions": 0, "comments": 0, "unanswered": 0, "topics": 0, "answers": 0, "questions": 0, "users": 0 }, "sections": [], "policies": { "email": "enabled", "cookieConsent": "disabled", "registration": "public", "content": "shareable", "access": "public" }, "stage": "inception", "status": "live", "type": "general", "plan": "basic", "topics": [], "aliases": [], "corsWhitelist": [], "id": "5c7bf24f157c2c34f735a539", "updateHash": "3fa36c8343b45caeb47b31c8c59a082b" } The endpoint uninstalls an app in the portal. HTTP Request DELETE /api/v1/apps/:id/settings URL Parameters Parameter Type Description id String The ID of app to uninstall Post Get All Post curl "https://community.tribe.so/api/v1/posts" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "5c0621864cb2b119dc174a63", "shortId": "Px10b", "lang": "en", "updatedAt": "2018-12-04T06:41:25.370Z", "createdAt": "2018-12-04T06:41:10.046Z", "title": "This is a test discussion.", "content": "

Here is the content of the discussion.

", "portal": "5a73b1fcc48071e4c4dc1cae", "publishedAt": "2018-12-04T06:41:10.031Z", "user": { "_id": "5b1f99a7478dd3768d84b646", "profile": { "counts": { "requests": 2, "edits": 46, "questionsFollowers": 0, "questions": 2, "comments": 2, "answersWords": 1586, "answersVotes": 0, "answersViews": 0, "answers": 12, "views": 0, "followings": 3, "followers": 3 }, "score": 52, "externalId": null, "verified": true, "description": "

Here is the content of the discussion.

). For Video To attach a video to a post, first we need to send the video to this endpoint. The endpoint uploads to Amazon S3 and returns the url of the original video. For simple post type, you can pass an array of urls to the post creation end-point (POST /api/v1/posts). You should pass the array in the body with videos key. Once the Post is created, the video is queued for processing. If the original video is in MP4 format, it will be readily available for the users to view it. In case the video is in any other format, the video's status will be set to "processing" under videos key. Upon completion, the video's status is updated to "complete" and poster, duration, and src with different compressions will be added to the video object. Update a Specific Post curl "https://community.tribe.so/api/v1/posts/5c0621864cb2b119dc174a63" -X PUT -H "Authorization: Bearer {access_token}" --DATA "{data}" This endpoint updates a specific post. HTTP Request PUT /api/v1/posts/:id URL Parameters Parameter Type Description id String The ID of the post to update Request Parameters Parameter Type Description title String The title of the post content String The content of the post Extra Request Parameters for Moderators Parameter Type Description locked Boolean Is the post locked? verified Boolean Is the post verified? status String The status of the post. Can be: new draft published unlisted archived collapsed scheduled unapproved Delete a Specific Post curl "https://community.tribe.so/api/v1/posts/5c0621864cb2b119dc174a63" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint deletes a specific post. HTTP Request DELETE /api/v1/posts/{id} URL Parameters Parameter Type Description id String The ID of the post to delete Get Post's Responses curl "https://community.tribe.so/api/v1/posts/5c0621864cb2b119dc174a63/responses" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "5c062192f3d2d61a37864a5b", "shortId": "PKqoR", "lang": "en", "updatedAt": "2018-12-04T06:41:22.270Z", "createdAt": "2018-12-04T06:41:22.270Z", "content": "

This is a test response to a discussion.

", "parent": "5c0621864cb2b119dc174a63", "portal": "5a73b1fcc48071e4c4dc1cae", "publishedAt": "2018-12-04T06:41:22.262Z", "user": { "_id": "5b1f99a7478dd3768d84b646", "profile": { "counts": { "requests": 2, "edits": 46, "questionsFollowers": 0, "questions": 2, "comments": 2, "answersWords": 1586, "answersVotes": 0, "answersViews": 0, "answers": 12, "views": 0, "followings": 3, "followers": 3 }, "score": 52, "externalId": null, "verified": true, "description": "

", "title": "Tribe Moderator", "picture": "/files/users/646/5b1f99a7478dd3768d84b646_66172.png", "website": "", "location": "", "gender": "male", "name": "Siavash Mahmoudian", "username": "siavash" }, "id": "5b1f99a7478dd3768d84b646" }, "__v": 0, "referrers": [], "global": true, "downvotes": [], "upvotes": [], "comments": [], "rewards": [], "videos": [], "files": [], "images": [], "attachments": [], "links": [], "topics": [], "posters": [], "followers": [], "score": 0, "counts": { "downvotes": 0, "links": 0, "totalUpvotes": 0, "upvotes": 0, "followers": 1, "users": 1, "edits": 0, "responses": 0, "comments": 0, "views": 0 }, "status": "published", "privacy": "public", "type": "response", "anonymous": false, "verified": false, "responses": [], "summary": "This is a test response to a discussion.", "id": "5c062192f3d2d61a37864a5b", "upvoted": false, "downvoted": false, "followed": false } ] HTTP Request GET /api/v1/posts/{id}/responses URL Parameters Parameter Type Description id String The ID of the question Query Parameters Parameter Type Default Description page Number 1 Intended page limit Number 20 Number of items per page sort String createdAt.desc The field to sort on Upvote for a Specific Post curl "https://community.tribe.so/api/v1/posts/5c0621864cb2b119dc174a63/votes" -X POST -H "Authorization: Bearer {access_token}" This endpoint upvotes a specific post. HTTP Request POST /api/v1/posts/{id}/votes URL Parameters Parameter Type Description id String The ID of the post to upvote Remove an Upvote for a Specific Post curl "https://community.tribe.so/api/v1/posts/5c0621864cb2b119dc174a63/votes" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint removes an upvote a specific post. HTTP Request DELETE /api/v1/posts/{id}/votes URL Parameters Parameter Type Description id String The ID of the post to remove an upvote Add a Comment for a Specific Post curl "https://community.tribe.so/api/v1/posts/5bf0e89ada3be54c190b78ba/comments" -X POST -H "Authorization: Bearer {access_token}" --DATA "{'body':'New comment'}" This endpoint adds a comment for a specific post. HTTP Request POST /api/v1/posts/:id/comments URL Parameters Parameter Type Description id String The ID of the post to add a comment Request Parameters Parameter Type Description body String The content of the comment Extra Request Parameters for Moderators Parameter Type Description user String The ID of the user to comment on behalf Update a Specific Comment for a Specific Post curl "https://community.tribe.so/api/v1/posts/5bf0e89ada3be54c190b78ba/comments/4sf0e89ada3be54c190b78b2" -X PUT -H "Authorization: Bearer {access_token}" --DATA "{'body':'Updated comment'}" This endpoint updates a specific comment. HTTP Request PUT /api/v1/posts/:postId/comments/:id URL Parameters Parameter Type Description id String The ID of the comment to update postId String The ID of the post to add a comment Request Parameters Parameter Type Description body String The content of the comment Remove a Specific Comment from Specific Post curl "https://community.tribe.so/api/v1/posts/5bf0e89ada3be54c190b78ba/comments/4sf0e89ada3be54c190b78b2" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint removes a specific comment. HTTP Request DELETE /api/v1/posts/:postId/comments/:id URL Parameters Parameter Type Description id String The ID of the comment to remove postId String The ID of the post to remove a comment Reporting a Specific Post curl "https://community.tribe.so/api/v1/posts/5a816275f8030b3bdd655b0d/reports" -X POST -H "Authorization: Bearer {access_token}" This endpoint reports (flags) a specific post to admins and moderators. HTTP Request POST /api/v1/posts/:id/reports URL Parameters Parameter Type Description id String The ID of the post to report Query Parameters Parameter Type Description type String The type of the report. Can be Harrasment, Spam, PoorlyWritten, IncorrectTopics, or AgainstRules description String The optional description of the report shown to admins and moderators Questions Get All Questions curl "https://community.tribe.so/api/v1/questions" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "5a816275f8030b3bdd655b0d", "updatedAt": "2018-02-12T19:07:21.136Z", "createdAt": "2018-02-12T09:46:29.646Z", "title": "What is a perfect life?", "lastAskedAt": "2018-02-12T09:46:29.642Z", "__v": 0, "lastAnsweredAt": "2018-02-12T19:07:21.135Z", "downvotes": [], "upvotes": [], "followers": [], "askers": [], "comments": [], "topics": [], "score": 0, "counts": { "asks": 1, "downvotes": 0, "upvotes": 0, "edits": 2, "comments": 0, "hiddenAnswers": 0, "answers": 2, "views": 8, "followers": 0 }, "type": "general", "anonymous": true, "verified": false, "locked": false, "followed": false } ] This endpoint retrieves all questions. HTTP Request GET /api/v1/questions Query Parameters Parameter Type Default Description page Number 1 Intended page limit Number 20 Number of items per page sort String createdAt.desc The field to sort on Get a Specific Question curl "https://community.tribe.so/api/v1/questions/5a816275f8030b3bdd655b0d" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "_id": "5a816275f8030b3bdd655b0d", "updatedAt": "2018-02-12T19:07:21.136Z", "createdAt": "2018-02-12T09:46:29.646Z", "title": "What is a perfect life?", "lastAskedAt": "2018-02-12T09:46:29.642Z", "__v": 0, "lastAnsweredAt": "2018-02-12T19:07:21.135Z", "downvotes": [], "upvotes": [], "followers": [], "askers": [], "comments": [], "topics": [], "score": 0, "counts": { "asks": 1, "downvotes": 0, "upvotes": 0, "edits": 2, "comments": 0, "hiddenAnswers": 0, "answers": 2, "views": 8, "followers": 0 }, "type": "general", "anonymous": true, "verified": false, "locked": false, "followed": false } This endpoint retrieves a specific question using ID. HTTP Request GET /api/v1/questions/{id} URL Parameters Parameter Type Description id String The ID of the item Delete a Specific Question curl "https://community.tribe.so/api/v1/questions/5a816275f8030b3bdd655b0d" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint deletes a specific question. HTTP Request DELETE /api/v1/questions/{id} URL Parameters Parameter Type Description id String The ID of the question to delete Get Question's Answers curl "https://community.tribe.so/api/v1/questions/5a816275f8030b3bdd655b0d/answers" -H "Authorization: Bearer {access_token}" HTTP Request GET /api/v1/questions/{id}/answers URL Parameters Parameter Type Description id String The ID of the question Query Parameters Parameter Type Default Description page Number 1 Intended page limit Number 20 Number of items per page sort Number createdAt.desc The field to sort on Get Question's Experts curl "https://community.tribe.so/api/v1/questions/5a816275f8030b3bdd655b0d/experts" -H "Authorization: Bearer {access_token}" HTTP Request GET /api/v1/questions/{id}/experts URL Parameters Parameter Type Description id String The ID of the question Get a Question's Recommendations curl "https://community.tribe.so/api/v1/questions/5a816275f8030b3bdd655b0d/recommendations" -H "Authorization: Bearer {access_token}" HTTP Request GET /api/v1/questions/{id}/recommendations URL Parameters Parameter Type Description id String The ID of the question Get Similar Questions curl "https://community.tribe.so/api/v1/questions/similars" -H "Authorization: Bearer {access_token}" This endpoint find related questions to keywords or a question title. HTTP Request GET /api/v1/questions/similars Query Parameters Parameter Type Default Description query String "" Keywords or title of a question Create a Question curl "https://community.tribe.so/api/v1/questions" -X POST -H "Authorization: Bearer {access_token}" This endpoint creates a new question. HTTP Request POST /api/v1/questions Query Parameters Parameter Type Description title String The title of the question to create description String The description of the question to create anonymous Boolean Is this an anonymous question? from String The ID of the user who has beend asked from topics [String] The IDs of the topics related to the question group String The ID of the group to post options [{ text: String }] (Optional) An array of poll options in [{ text: 'Option text' }] format Extra Query Parameters for Moderators Parameter Type Description type String The type of the question to create locked Boolean Is the question locked? verified Boolean Is the question verified? status String Status of the question to create. Can be: archived collapsed published unapproved unlisted featured scheduled user String The ID of the user to ask a question on behalf Add Image, File or Video to a Question This endpoint uploads a new file that can be attached to a Question. HTTP Request @deprecated POST /api/v1/questions/image This endpoint has been deprecated and will be removed in a future version. POST /api/v1/uploads/questions The above command returns JSON structured like this for Image, File or Video: { "uploaded": true, "url": "https://static.t-cdn.net/.../questions/.../file" } Request Parameters Parameter Type Description upload File The image, file or video in multipart/form-data format. Supported video formats For Image or File To attach an image or a file to a question, first we need to send the file to this endpoint. The endpoint resizes the images, scans files, and returns the url of the image or file. You can pass an array of urls to the question creation end-point (POST /api/v1/questions). You should pass the array in the body with images or files key. For Video To attach a video to a question, first we need to send the video to this endpoint. The endpoint uploads to Amazon S3 and returns the url of the original video. You can pass an array of urls to the question creation end-point (POST /api/v1/questions). You should pass the array in the body with videos key. Once the Question is created, the video is queued for processing. If the original video is in MP4 format, it will be readily available for the users to view it. In case the video is in any other format, the video's status will be set to "processing" under videos key. Upon completion, the video's status is updated to "complete" and poster, duration, and src with different compressions will be added to the video object. Update a Specific Question curl "https://community.tribe.so/api/v1/questions/5a816275f8030b3bdd655b0d" -X PUT -H "Authorization: Bearer {access_token}" This endpoint updates a specific question. HTTP Request PUT /api/v1/questions/:id URL Parameters Parameter Type Description id String The ID of the question to update Query Parameters Parameter Type Description title String The title of the question to create description String The description of the question to create anonymous Boolean Is this an anonymous question? options [{ text: String, _id: ID }] (Optional) An array of poll options in [{ text: 'Option text', _id: "5e2...ab" }] format. _id is the ID of the option passed while fetching a question object. Extra Query Parameters for Moderators Parameter Type Description type String The type of the question to create locked Boolean Is the question locked? verified Boolean Is the question verified? status String Status of the question to create. Can be: archived collapsed published unapproved unlisted featured scheduled Add a Comment for a Specific Question curl "https://community.tribe.so/api/v1/questions/5bf0e89ada3be54c190b78ba/comments" -X POST -H "Authorization: Bearer {access_token}" --DATA "{'body':'New comment'}" This endpoint adds a comment for a specific question. HTTP Request POST /api/v1/questions/:id/comments URL Parameters Parameter Type Description id String The ID of the question to add a comment Request Parameters Parameter Type Description body String The content of the comment Extra Request Parameters for Moderators Parameter Type Description user String The ID of the user to comment on behalf Update a Specific Comment for a Specific Question curl "https://community.tribe.so/api/v1/questions/5bf0e89ada3be54c190b78ba/comments/4sf0e89ada3be54c190b78b2" -X PUT -H "Authorization: Bearer {access_token}" --DATA "{'body':'Updated comment'}" This endpoint updates a specific comment. HTTP Request PUT /api/v1/questions/:questionId/comments/:id URL Parameters Parameter Type Description id String The ID of the comment to update questionId String The ID of the question to add a comment Request Parameters Parameter Type Description body String The content of the comment Remove a Specific Comment from Specific Question curl "https://community.tribe.so/api/v1/questions/5bf0e89ada3be54c190b78ba/comments/4sf0e89ada3be54c190b78b2" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint removes a specific comment. HTTP Request DELETE /api/v1/questions/:questionId/comments/:id URL Parameters Parameter Type Description id String The ID of the comment to remove questionId String The ID of the question to remove a comment Get Stats of Specific User for Questions curl "https://community.tribe.so/api/v1/user/stats/questions/views" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "values": { "2019-02-10": 0, "2019-02-11": 0, "2019-02-12": 0, "2019-02-13": 0, "2019-02-14": 0, "2019-02-15": 0, "2019-02-16": 0, "2019-02-17": 0, "2019-02-18": 0, "2019-02-19": 0, "2019-02-20": 0, "2019-02-21": 0, "2019-02-22": 0, "2019-02-23": 0, "2019-02-24": 0, "2019-02-25": 0, "2019-02-26": 0, "2019-02-27": 0, "2019-02-28": 0, "2019-03-01": 0, "2019-03-02": 0, "2019-03-03": 0, "2019-03-04": 0, "2019-03-05": 0, "2019-03-06": 0, "2019-03-07": 0, "2019-03-08": 0, "2019-03-09": 0, "2019-03-10": 0, "2019-03-11": 0, "2019-03-12": 0, "2019-03-13": 0 }, "type": "user_question_viewed", "timestamp": "2019-03-01" } This endpoint returns statistics of a specific user for questions. HTTP Request GET /api/v1/user/stats/questions/:metric Request Parameters Parameter Type Description metric String Metric for the statistics. Can be: views,votes,follows Follow a question curl "https://community.tribe.so/api/v1/questions/5bf0e89ada3be54c190b78ba/followers" -X POST -H "Authorization: Bearer {access_token}" This endpoint follows a question. HTTP Request POST /api/v1/questions/{id}/followers Unfollow a question curl "https://community.tribe.so/api/v1/questions/5bf0e89ada3be54c190b78ba/followers" -X DELETE -H "Authorization: Bearer {access_token}" This endpoint unfollows a question. HTTP Request DELETE /api/v1/questions/{id}/followers Reporting a Specific Question curl "https://community.tribe.so/api/v1/questions/5a816275f8030b3bdd655b0d/reports" -X POST -H "Authorization: Bearer {access_token}" This endpoint reports (flags) a specific question to admins and moderators. HTTP Request POST /api/v1/questions/:id/reports URL Parameters Parameter Type Description id String The ID of the question to report Query Parameters Parameter Type Description type String The type of the report. Can be Harrasment, Spam, Insincere, PoorlyWritten, IncorrectTopics, or AgainstRules description String The optional description of the report shown to admins and moderators Topics Get All Topics curl "https://community.tribe.so/api/v1/topics" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "5b88264d3d9228aa7c41f692", "name": "Tribe", "portal": "5a73b1fcc48071e4c4dc1cae", "updatedAt": "2018-11-29T06:16:08.223Z", "__v": 8, "createdAt": "2018-08-30T17:15:57.884Z", "aliases": [], "children": [ "5bb1abe13d9228aa7c4242ba", "5babb4603d9228aa7c423c23", "5bbf7b083d9228aa7c427450", "5babe5eb3d9228aa7c423c66" ], "counts": { "questions": 55, "followers": 3, "subquestions": 79, "children": 4 }, "definitions": [], "paths": [ [ { "_id": "5b88264d3d9228aa7c41f692", "name": "Tribe", "picture": "/files/topics/692/5b88264d3d9228aa7c41f692_72807.png" } ] ], "shortId": "5oqoy", "user": "5b881b2a90ecbe6751123d7e", "picture": "/files/topics/692/5b88264d3d9228aa7c41f692_72807.png", "experts": { "5b881b2a90ecbe6751123d7e": 24, "5b3f7fe0d5a11b6297259cab": 16, "5b1f99a7478dd3768d84b646": 12, "5b913111f19a473232026877": 3, "5ba95b5c630b876a1e9785a5": 1 }, "about": "", "followed": true } ] This endpoint retrieves all topics. HTTP Request GET /api/v1/topics Query Parameters Parameter Type Default Description page Number 1 Intended page limit Number 20 Number of items per page sort String createdAt.desc The field to sort on type String Filter topics based on their type. Can be category, collection, or tag definition String Filter topics based on their definition Get a Specific Topic curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "_id": "5b88264d3d9228aa7c41f692", "name": "Tribe", "portal": "5a73b1fcc48071e4c4dc1cae", "updatedAt": "2018-11-29T06:16:08.223Z", "__v": 8, "createdAt": "2018-08-30T17:15:57.884Z", "aliases": [], "children": [ "5bb1abe13d9228aa7c4242ba", "5babb4603d9228aa7c423c23", "5bbf7b083d9228aa7c427450", "5babe5eb3d9228aa7c423c66" ], "counts": { "questions": 55, "followers": 3, "subquestions": 79, "children": 4 }, "definitions": [], "paths": [ [ { "_id": "5b88264d3d9228aa7c41f692", "name": "Tribe", "picture": "/files/topics/692/5b88264d3d9228aa7c41f692_72807.png" } ] ], "shortId": "5oqoy", "user": "5b881b2a90ecbe6751123d7e", "picture": "/files/topics/692/5b88264d3d9228aa7c41f692_72807.png", "experts": { "5b881b2a90ecbe6751123d7e": 24, "5b3f7fe0d5a11b6297259cab": 16, "5b1f99a7478dd3768d84b646": 12, "5b913111f19a473232026877": 3, "5ba95b5c630b876a1e9785a5": 1 }, "about": "", "followed": true } This endpoint retrieves a specific topic using ID. HTTP Request GET /api/v1/topics/{id} URL Parameters Parameter Type Description id String The ID of the item Create a Topic curl "https://community.tribe.so/api/v1/topics" -X POST -H "Authorization: Bearer {access_token}" -H 'Content-Type: application/json; charset=utf-8' \ --DATA '{"name":"Test Topic"}' The above command returns JSON structured like this: { "_id": "5b88264d3d9228aa7c41f693", "name": "Test Topic", "portal": "5a73b1fcc48071e4c4dc1cae", "updatedAt": "2018-11-29T06:16:08.223Z", "__v": 8, "createdAt": "2018-08-30T17:15:57.884Z", "aliases": [], "children": [], "counts": { "questions": 0, "followers": 0, "subquestions": 0, "children": 0 }, "definitions": [], "paths": [], "shortId": "5oqoy", "user": "5b881b2a90ecbe6751123d7e", "experts": {}, "about": "", "followed": false } This endpoint creates a new topic. HTTP Request POST /api/v1/topics Request Parameters Parameter Type Default Description name String null The name of the Topic about String null The description of the Topic picture String null Url to a picture for this Topic definitions [String] [] The different types assigned with the Topic. It can be an array of following: ['Concept', 'Location', 'Localizable','Activity', 'QuestionType', 'Category', 'Event', 'Person', 'AcademicField', 'Job', 'Person', 'Company', 'School', 'Product', 'Adult'] aliases [String] [] An array of Aliases for this Topic. Aliases help users search the Topic with different keywords. externalId String null The unique ID of the Topic in an external platform. This is useful when creating a Topic for an external entity. upsert Boolean false If true, it will try to create the topic, if a topic with same name exists it'll return the topic. If false, it will throw an error if a topic with the same name exists. Update a Specific Topic curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692" -X PUT -H "Authorization: Bearer {access_token}" -H 'Content-Type: application/json; charset=utf-8' \ --DATA '{data}' This endpoint updates a specific topic. HTTP Request PUT /api/v1/topics/:id URL Parameters Parameter Type Default id String The ID of the topic to update Request Parameters Parameter Type Default Description name String null The name of the Topic about String null The description of the Topic definitions [String] [] The different types assigned with the Topic. It can be an array of following: ['Concept', 'Location', 'Localizable','Activity', 'QuestionType', 'Category', 'Event', 'Person', 'AcademicField', 'Job', 'Person', 'Company', 'School', 'Product', 'Adult'] aliases [String] [] An array of Aliases for this Topic. Aliases help users search the Topic with different keywords. Extra Request Parameters Parameter Type Default Description picture String null Url to a picture for this Topic externalId String null The unique ID of the Topic in an external platform. This is useful when creating a Topic for an external entity. Delete a Specific Topic curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692" -X DELETE -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: { "success": true } This endpoint deletes a specific topic. HTTP Request DELETE /api/v1/topics/{id} URL Parameters Parameter Type Description id String The ID of the topic to delete Get Topic's Questions curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692/questions" -H "Authorization: Bearer {access_token}" HTTP Request GET /api/v1/topics/{id}/questions URL Parameters Parameter Type Description id String The ID of the topic Get Topic's Experts curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692/experts" -H "Authorization: Bearer {access_token}" HTTP Request GET /api/v1/topics/{id}/experts URL Parameters Parameter Type Description id String The ID of the topic Add a Child curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692/children" -X POST -H "Authorization: Bearer {access_token}" --DATA '{ name: "Child" }' HTTP Request POST /api/v1/topics/{id}/children URL Parameters Parameter Type Description id String The ID of the topic Request Parameters Parameter Type Description name String Name of the child to add Remove a Child curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692/children/4c88264d3d9118aa7c41f6ff" -X DELETE -H "Authorization: Bearer {access_token}" HTTP Request DELETE /api/v1/topics/:id/children/:childId URL Parameters Parameter Type Description id String The ID of the topic childId String The ID of the child to delete Follow a topic curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692/followers" -X POST -H "Authorization: Bearer {access_token}" This endpoint follows a topic. HTTP Request POST /api/v1/topics/{id}/followers Unfollow a topic curl "https://community.tribe.so/api/v1/topics/5b88264d3d9228aa7c41f692/followers" -X DELETE -H "Authorization: Bearer {access_token}" This endpoint unfollows a topic. HTTP Request DELETE /api/v1/topics/{id}/followers Users Get All Users curl "https://community.tribe.so/api/v1/users" -H "Authorization: Bearer {access_token}" The above command returns JSON structured like this: [ { "_id": "5b1f99a7478dd3768d84b646", "profile": { "counts": { "requests": 2, "edits": 46, "questionsFollowers": 0, "questions": 2, "comments": 2, "answersWords": 1586, "answersVotes": 0, "answersViews": 0, "answers": 12, "views": 0, "followings": 3, "followers": 3 }, "score": 52, "externalId": null, "verified": true, "description": "", "title": "Tribe Moderator", "picture": "", "website": "", "location": "", "gender": "male", "name": "John Smith", "username": "john" }, "id": "5b1f99a7478dd3768d84b646", "followed": false } ] This endpoint retrieves all users. HTTP Request GET /api/v1/users Query Parameters Parameter Type Default Description page Number 1 Intended page limit Number 20 Number of items per page sort Number createdAt.desc The field to sort on query String Query to filter on name, username, and title Extra Query Parameters for Moderators Parameter Type Default Description role String Filter users based on role. Can be admin, moderator, member, and bot email String Comma separated list of emails to filter on Create a new User curl "https://community.tribe.so/api/v1/users" -X POST -H "Authorization: Bearer {access_token}" --DATA '{data}' This endpoint creates a new user. HTTP Request POST /api/v1/users/ Request Parameters Parameter Type Description Required username String Username of the user Yes name String Name of the user Yes email String Email of the user Yes password String Password of the user Yes confirmPassword String Confirm password of the user No Extra Request Parameters for Admins Parameter Type Description Required externalId String The ID of user in the external service No role String The role of the user. Can be member, moderator, or admin No source String The source of the user (e.g. API, SSO, Google, etc.) Can be used for analytics. No Invite new Users curl "https://community.tribe.so/api/v1/user/email/invitations" -X POST -H "Authorization: Bearer {access_token}" --DATA '{data}' The above command returns JSON structured like this: { "success": true, "count": 1 } This endpoint send invitation email to people. The free plan is limited to 50 invitaions per day. HTTP Request POST /api/v1/user/email/invitations/ Request Parameters Parameter Type Description Required role String Role of the users Yes users Array