Forem API V1

Tools (42)

Extracted live via the executor SDK.

• articles.createArticle

  This endpoint allows the client to create a new article.

  "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.

• articles.getArticleById

  This endpoint allows the client to retrieve a single published article given its id.

• articles.getArticleByPath

  This endpoint allows the client to retrieve a single published article given its path.

• articles.getArticles

  This endpoint allows the client to retrieve a list of articles.

  "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.

  By default it will return featured, published articles ordered by descending popularity.

  It supports pagination, each page will contain 30 articles by default.

• articles.getLatestArticles

  This endpoint allows the client to retrieve a list of articles. ordered by descending publish date.

  It supports pagination, each page will contain 30 articles by default.

• articles.getUserAllArticles

  This endpoint allows the client to retrieve a list of all articles on behalf of an authenticated user.

  "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.

  It will return both published and unpublished articles with pagination.

  Unpublished articles will be at the top of the list in reverse chronological creation order. Published articles will follow in reverse chronological publication order.

  By default a page will contain 30 articles.

• articles.getUserArticles

  This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user.

  "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.

  Published articles will be in reverse chronological publication order.

  It will return published articles with pagination. By default a page will contain 30 articles.

• articles.getUserPublishedArticles

  This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user.

  "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.

  Published articles will be in reverse chronological publication order.

  It will return published articles with pagination. By default a page will contain 30 articles.

• articles.getUserUnpublishedArticles

  This endpoint allows the client to retrieve a list of unpublished articles on behalf of an authenticated user.

  "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.

  Unpublished articles will be in reverse chronological creation order.

  It will return unpublished articles with pagination. By default a page will contain 30 articles.

• articles.unpublishArticle

  This endpoint allows the client to unpublish an article.

  The user associated with the API key must have any 'admin' or 'moderator' role.

  The article will be unpublished and will no longer be visible to the public. It will remain in the database and will set back to draft status on the author's posts dashboard. Any notifications associated with the article will be deleted. Any comments on the article will remain.

• articles.updateArticle

  This endpoint allows the client to update an existing article.

  "Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.

• comments.getCommentById

  This endpoint allows the client to retrieve a comment as well as his descendants comments.

  It will return the required comment (the root) with its nested descendants as a thread.

  See the format specification for further details.

• comments.getCommentsByArticleId

  This endpoint allows the client to retrieve all comments belonging to an article or podcast episode as threaded conversations.

  It will return the all top level comments with their nested comments as threads. See the format specification for further details.

• displayAds.getApiDisplayAds

  This endpoint allows the client to retrieve a list of all display ads.

• displayAds.getApiDisplayAdsId

  This endpoint allows the client to retrieve a single display ad, via its id.

• displayAds.postApiDisplayAds

  This endpoint allows the client to create a new display ad.

• displayAds.putApiDisplayAdsId

  This endpoint allows the client to update the attributes of a single display ad, via its id.

• displayAds.putApiDisplayAdsIdUnpublish

  This endpoint allows the client to remove a display ad from rotation by un-publishing it.

• followedTags.getFollowedTags

  This endpoint allows the client to retrieve a list of the tags they follow.

• followers.getFollowers

  This endpoint allows the client to retrieve a list of the followers they have. "Followers" are users that are following other users on the website. It supports pagination, each page will contain 80 followers by default.

• organizations.getOrganization

  This endpoint allows the client to retrieve a single organization by their username

• organizations.getOrgArticles

  This endpoint allows the client to retrieve a list of Articles belonging to the organization

  It supports pagination, each page will contain 30 users by default.

• organizations.getOrgUsers

  This endpoint allows the client to retrieve a list of users belonging to the organization

  It supports pagination, each page will contain 30 users by default.

• pages.deleteApiPagesId

  This endpoint allows the client to delete a single Page object, specified by ID.

• pages.getApiPages

  This endpoint allows the client to retrieve details for all Page objects.

• pages.getApiPagesId

  This endpoint allows the client to retrieve details for a single Page object, specified by ID.

• pages.postApiPages

  This endpoint allows the client to create a new page.

• pages.putApiPagesId

  This endpoint allows the client to retrieve details for a single Page object, specified by ID.

• podcastEpisodes.getPodcastEpisodes

  This endpoint allows the client to retrieve a list of podcast episodes. "Podcast episodes" are episodes belonging to podcasts. It will only return active (reachable) podcast episodes that belong to published podcasts available on the platform, ordered by descending publication date. It supports pagination, each page will contain 30 articles by default.

• profileImages.getProfileImage

  This endpoint allows the client to retrieve a user or organization profile image information by its corresponding username.

• reactions.postApiReactions

  This endpoint allows the client to create a reaction to a specified reactable (eg, Article, Comment, or User). For examples: * "Like"ing an Article will create a new "like" Reaction from the user for that Articles * "Like"ing that Article a second time will return the previous "like"

• reactions.postApiReactionsToggle

  This endpoint allows the client to toggle the user's reaction to a specified reactable (eg, Article, Comment, or User). For examples: * "Like"ing an Article will create a new "like" Reaction from the user for that Articles * "Like"ing that Article a second time will remove the "like" from the user

• readinglist.getReadinglist

  This endpoint allows the client to retrieve a list of articles that were saved to a Users readinglist. It supports pagination, each page will contain 30 articles by default

• tags.getTags

  This endpoint allows the client to retrieve a list of tags that can be used to tag articles.

  It will return tags ordered by popularity.

  It supports pagination, each page will contain 10 tags by default.

• users.getUser

  This endpoint allows the client to retrieve a single user, either by id or by the user's username.

  For complete documentation, see the v0 API docs: https://developers.forem.com/api/v0#tag/users/operation/getUser

• users.getUserMe

  This endpoint allows the client to retrieve information about the authenticated user

• users.postAdminUsersCreate

  This endpoint allows the client to trigger an invitation to the provided email address.

      It requires a token from a user with `super_admin` privileges.

• users.suspendUser

  This endpoint allows the client to suspend a user.

  The user associated with the API key must have any 'admin' or 'moderator' role.

  This specified user will be assigned the 'suspended' role. Suspending a user will stop the user from posting new posts and comments. It doesn't delete any of the user's content, just prevents them from creating new content while suspended. Users are not notified of their suspension in the UI, so if you want them to know about this, you must notify them.

• users.unpublishUser

  This endpoint allows the client to unpublish all of the articles and comments created by a user.

  The user associated with the API key must have any 'admin' or 'moderator' role.

  This specified user's articles and comments will be unpublished and will no longer be visible to the public. They will remain in the database and will set back to draft status on the specified user's dashboard. Any notifications associated with the specified user's articles and comments will be deleted.

  Note this endpoint unpublishes articles and comments asychronously: it will return a 204 NO CONTENT status code immediately, but the articles and comments will not be unpublished until the request is completed on the server.

• videos.getOperation

  This endpoint allows the client to retrieve a list of articles that are uploaded with a video.

  It will only return published video articles ordered by descending popularity.

  It supports pagination, each page will contain 24 articles by default.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools