Access Forem articles, users and other resources via API. For a real-world example of Forem in action, check out [DEV](https://www.dev.to). All endpoints can be accessed with the 'api-key' header and a accept header, but some of them are accessible publicly without authentica
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://dev.to/api
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Access Forem articles, users and other resources via API. For a real-world example of Forem in action, check out [DEV](https://www.dev.to). All endpoints can be accessed with the 'api-key' header and a accept header, but some of them are accessible publicly without authentication. Dates and date times, unless otherwise specified, must be in the [RFC 3339](h
| method | path | what the vendor says it does |
|---|---|---|
POST | /api/admin/users | Invite a User This endpoint allows the client to trigger an invitation to the provided email address. |
GET | /api/articles | Published articles This endpoint allows the client to retrieve a list of articles. "Articles" are all the pos |
POST | /api/articles | Publish article This endpoint allows the client to create a new article. "Articles" are all the posts that us |
GET | /api/articles/latest | Published articles sorted by published date This endpoint allows the client to retrieve a list of articles. or |
GET | /api/articles/me | User's articles This endpoint allows the client to retrieve a list of published articles on behalf of an authe |
GET | /api/articles/me/all | User's all articles This endpoint allows the client to retrieve a list of all articles on behalf of an authent |
GET | /api/articles/me/published | User's published articles This endpoint allows the client to retrieve a list of published articles on behalf o |
GET | /api/articles/me/unpublished | User's unpublished articles This endpoint allows the client to retrieve a list of unpublished articles on beha |
GET | /api/articles/{id} | Published article by id This endpoint allows the client to retrieve a single published article given its `id`. |
PUT | /api/articles/{id} | Update an article by id This endpoint allows the client to update an existing article. "Articles" are all the |
PUT | /api/articles/{id}/unpublish | Unpublish an article This endpoint allows the client to unpublish an article. The user associated with the AP |
GET | /api/articles/{username}/{slug} | Published article by path This endpoint allows the client to retrieve a single published article given its `pa |
GET | /api/comments | Comments This endpoint allows the client to retrieve all comments belonging to an article or podcast episode a |
GET | /api/comments/{id} | Comment by id This endpoint allows the client to retrieve a comment as well as his descendants comments. It |
GET | /api/display_ads | display ads This endpoint allows the client to retrieve a list of all display ads. display ads |
POST | /api/display_ads | display ads This endpoint allows the client to create a new display ad. display ads |
GET | /api/display_ads/{id} | display ad This endpoint allows the client to retrieve a single display ad, via its id. display ads |
PUT | /api/display_ads/{id} | display ads This endpoint allows the client to update the attributes of a single display ad, via its id. displ |
PUT | /api/display_ads/{id}/unpublish | unpublish This endpoint allows the client to remove a display ad from rotation by un-publishing it. display ad |
GET | /api/followers/users | Followers This endpoint allows the client to retrieve a list of the followers they have. "Followers" a |
GET | /api/follows/tags | Followed Tags This endpoint allows the client to retrieve a list of the tags they follow. followed_tags tags |
GET | /api/organizations/{username} | An organization This endpoint allows the client to retrieve a single organization by their username organizati |
GET | /api/organizations/{username}/articles | Organization's Articles This endpoint allows the client to retrieve a list of Articles belonging to the organi |
GET | /api/organizations/{username}/users | Organization's users This endpoint allows the client to retrieve a list of users belonging to the organization |
GET | /api/pages | show details for all pages This endpoint allows the client to retrieve details for all Page objects. pages |
POST | /api/pages | pages This endpoint allows the client to create a new page. pages |
GET | /api/pages/{id} | show details for a page This endpoint allows the client to retrieve details for a single Page object, specifie |
PUT | /api/pages/{id} | update details for a page This endpoint allows the client to retrieve details for a single Page object, specif |
DELETE | /api/pages/{id} | remove a page This endpoint allows the client to delete a single Page object, specified by ID. pages |
GET | /api/podcast_episodes | Podcast Episodes This endpoint allows the client to retrieve a list of podcast episodes. "Podcast epis |
GET | /api/profile_images/{username} | A Users or organizations profile image This endpoint allows the client to retrieve a user or organization prof |
POST | /api/reactions | create reaction This endpoint allows the client to create a reaction to a specified reactable (eg, Article, Co |
POST | /api/reactions/toggle | toggle reaction This endpoint allows the client to toggle the user's reaction to a specified reactable (eg, Ar |
GET | /api/readinglist | Readinglist This endpoint allows the client to retrieve a list of articles that were saved to a Users readingl |
GET | /api/tags | Tags This endpoint allows the client to retrieve a list of tags that can be used to tag articles. It will ret |
GET | /api/users/me | The authenticated user This endpoint allows the client to retrieve information about the authenticated user us |
GET | /api/users/{id} | A User This endpoint allows the client to retrieve a single user, either by id or by the user's username. For |
PUT | /api/users/{id}/suspend | Suspend a User This endpoint allows the client to suspend a user. The user associated with the API key must h |
PUT | /api/users/{id}/unpublish | Unpublish a User's Articles and Comments This endpoint allows the client to unpublish all of the articles and |
GET | /api/videos | Articles with a video This endpoint allows the client to retrieve a list of articles that are uploaded with a |
specification origin: https://raw.githubusercontent.com/forem/forem/main/swagger/v1/api_v1.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.