← Tools Reference

Forem

Forem integration (Social, Developer Tools). Imported from open-connector.

API key8 tools{base_url}
GET
forem_get_current_user
Retrieve the Forem user associated with the connected API key.

/users/me

GET
forem_list_articles
List published Forem articles with optional filters.

/articles

9 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe pagination page number.
perPageintegeroptionalThe number of articles to return per page. Forem defaults to 30.
tagstringoptionalReturn articles containing this tag.
tagsarrayoptionalThe Forem tags to send as a comma-separated upstream value.
tagsExcludearrayoptionalThe Forem tags to send as a comma-separated upstream value.
usernamestringoptionalReturn articles for this user or organization username.
statestringoptionalThe Forem article list state filter.
topintegeroptionalReturn the most popular articles from the last N days.
collectionIdintegeroptionalReturn articles belonging to this collection ID.
GET
forem_list_my_articles
List articles owned by the authenticated Forem user.

/articles/me/unpublished

3 parameters
ParamTypeRequiredDescription
scopestringoptionalWhich authenticated-user article collection to list.
pageintegeroptionalThe pagination page number.
perPageintegeroptionalThe number of articles to return per page. Forem defaults to 30.
GET
forem_get_article
Retrieve one published Forem article by numeric ID.

/articles/{articleId}

1 parameter
ParamTypeRequiredDescription
articleIdintegerrequiredThe Forem article ID.
GET
forem_get_article_by_path
Retrieve one published Forem article by username and slug.

/articles/{username}/{slug}

2 parameters
ParamTypeRequiredDescription
usernamestringrequiredThe Forem username from the article path.
slugstringrequiredThe Forem article slug.
GET
forem_list_comments
List Forem comments for an article or podcast episode as threaded conversations.

/comments

4 parameters
ParamTypeRequiredDescription
articleIdintegeroptionalThe Forem article ID whose comments should be listed.
podcastEpisodeIdintegeroptionalThe Forem podcast episode ID whose comments should be listed.
pageintegeroptionalThe pagination page number.
perPageintegeroptionalThe number of articles to return per page. Forem defaults to 30.
GET
forem_get_comment
Retrieve one Forem comment thread by numeric ID.

/comments/{commentId}

1 parameter
ParamTypeRequiredDescription
commentIdintegerrequiredThe Forem comment ID.
GET
forem_list_tags
List Forem tags ordered by popularity.

/tags

2 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe pagination page number.
perPageintegeroptionalThe number of tags to return per page. Forem defaults to 10.