actionGETv1.0.0
A User
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
actionGETv1.0.0
A Users or organizations profile image
This endpoint allows the client to retrieve a user or organization profile image information by its corresponding username.
actionGETv1.0.0
An organization
This endpoint allows the client to retrieve a single organization by their username
actionGETv1.0.0
Articles with a video
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.
actionGETv1.0.0
Comment by id
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.
actionGETv1.0.0
Comments
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.
actionPOSTv1.0.0
create reaction
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"
actionGETv1.0.0
display ad
This endpoint allows the client to retrieve a single display ad, via its id.
actionGETv1.0.0
display ads
This endpoint allows the client to retrieve a list of all display ads.
actionPOSTv1.0.0
display ads
This endpoint allows the client to create a new display ad.
actionPUTv1.0.0
display ads
This endpoint allows the client to update the attributes of a single display ad, via its id.
actionGETv1.0.0
Followed Tags
This endpoint allows the client to retrieve a list of the tags they follow.
actionGETv1.0.0
Followers
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.
actionPOSTv1.0.0
Invite a User
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.
actionGETv1.0.0
Organization's Articles
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.
actionGETv1.0.0
Organization's users
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.
actionPOSTv1.0.0
pages
This endpoint allows the client to create a new page.
actionGETv1.0.0
Podcast Episodes
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.
actionPOSTv1.0.0
Publish article
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.
actionGETv1.0.0
Published article by id
This endpoint allows the client to retrieve a single published article given its `id`.
actionGETv1.0.0
Published article by path
This endpoint allows the client to retrieve a single published article given its `path`.
actionGETv1.0.0
Published articles
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.
actionGETv1.0.0
Published articles sorted by published date
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.
actionGETv1.0.0
Readinglist
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
actionDELETEv1.0.0
remove a page
This endpoint allows the client to delete a single Page object, specified by ID.
actionGETv1.0.0
show details for a page
This endpoint allows the client to retrieve details for a single Page object, specified by ID.
actionGETv1.0.0
show details for all pages
This endpoint allows the client to retrieve details for all Page objects.
actionPUTv1.0.0
Suspend a User
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.
actionGETv1.0.0
Tags
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.
actionGETv1.0.0
The authenticated user
This endpoint allows the client to retrieve information about the authenticated user
actionPOSTv1.0.0
toggle reaction
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
actionPUTv1.0.0
unpublish
This endpoint allows the client to remove a display ad from rotation by un-publishing it.
actionPUTv1.0.0
Unpublish a User's Articles and Comments
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.
actionPUTv1.0.0
Unpublish an article
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.
actionPUTv1.0.0
Update an article by id
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.
actionPUTv1.0.0
update details for a page
This endpoint allows the client to retrieve details for a single Page object, specified by ID.
actionGETv1.0.0
User's all articles
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.
actionGETv1.0.0
User's articles
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.
actionGETv1.0.0
User's published articles
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.
actionGETv1.0.0
User's unpublished articles
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.
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec