/api/admin/users

Invite a User

/api/articles

Published articles

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.
• tag (query) — Using this parameter will retrieve articles that contain the requested tag. Articles will be ordered by descending popularity.This parameter can be used in conjuction with `top`.
• tags (query) — Using this parameter will retrieve articles with any of the comma-separated tags. Articles will be ordered by descending popularity.
• tags_exclude (query) — Using this parameter will retrieve articles that do _not_ contain _any_ of comma-separated tags. Articles will be ordered by descending popularity.
• username (query) — Using this parameter will retrieve articles belonging to a User or Organization ordered by descending publication date. If `state=all` the number of items returned will be `1000` instead of the default `30`. This parameter can be used in conjuction with `state`.
• state (query) — Using this parameter will allow the client to check which articles are fresh or rising. If `state=fresh` the server will return fresh articles. If `state=rising` the server will return rising articles. This param can be used in conjuction with `username`, only if set to `all`.
• top (query, limit) — Using this parameter will allow the client to return the most popular articles in the last `N` days. `top` indicates the number of days since publication of the articles returned. This param can be used in conjuction with `tag`.
• collection_id (query) — Adding this will allow the client to return the list of articles belonging to the requested collection, ordered by ascending publication date.

/api/articles

Publish article

/api/articles/latest

Published articles sorted by published date

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/articles/me

User's articles

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/articles/me/all

User's all articles

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/articles/me/published

User's published articles

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/articles/me/unpublished

User's unpublished articles

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/articles/{id}

Published article by id

• id (path, required)

/api/articles/{id}

Update an article by id

• id (path, required) — The ID of the user to unpublish.

/api/articles/{id}/unpublish

Unpublish an article

• id (path, required) — The ID of the article to unpublish.
• note (query) — Content for the note that's created along with unpublishing

/api/articles/{username}/{slug}

Published article by path

• username (path, required)
• slug (path, required)

/api/comments

Comments

• a_id (query) — Article identifier.
• p_id (query) — Podcast Episode identifier.

/api/comments/{id}

Comment by id

• id (path, required) — Comment identifier.

/api/display_ads

display ads

/api/display_ads

display ads

/api/display_ads/{id}

display ad

• id (path, required) — The ID of the user to unpublish.

/api/display_ads/{id}

display ads

• id (path, required) — The ID of the user to unpublish.

/api/display_ads/{id}/unpublish

unpublish

• id (path, required) — The ID of the user to unpublish.

/api/followers/users

Followers

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.
• sort (query) — Default is 'created_at'. Specifies the sort order for the created_at param of the follow relationship. To sort by newest followers first (descending order) specify ?sort=-created_at.

/api/follows/tags

Followed Tags

/api/organizations/{username}

An organization

• username (path, required)

/api/organizations/{username}/articles

Organization's Articles

• username (path, required)
• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/tags

Tags

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/organizations/{username}/users

Organization's users

• username (path, required)
• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/pages

show details for all pages

/api/pages

pages

/api/pages/{id}

remove a page

• id (path, required) — The ID of the page.

/api/pages/{id}

show details for a page

• id (path, required) — The ID of the page.

/api/pages/{id}

update details for a page

• id (path, required) — The ID of the page.

/api/podcast_episodes

Podcast Episodes

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.
• username (query) — Using this parameter will retrieve episodes belonging to a specific podcast.

/api/profile_images/{username}

A Users or organizations profile image

• username (path, required) — The parameter is the username of the user or the username of the organization.

/api/reactions

create reaction

• category (query, required)
• reactable_id (query, required)
• reactable_type (query, required)

/api/reactions/toggle

toggle reaction

• category (query, required)
• reactable_id (query, required)
• reactable_type (query, required)

/api/readinglist

Readinglist

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

/api/users/me

The authenticated user

/api/users/{id}

A User

• id (path, required)

/api/users/{id}/suspend

Suspend a User

• id (path, required) — The ID of the user to suspend.

/api/users/{id}/unpublish

Unpublish a User's Articles and Comments

• id (path, required) — The ID of the user to unpublish.

/api/videos

Articles with a video

• page (query, page) — Pagination page
• per_page (query, limit) — Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.