Skip to content
Changelog

Report a bug

DEV Community integration: operations for AI agents

DEV Community connects to Type.com as an integration. This page lists the 145 operations documented for Claude and Codex in Type.com: 79 read, 34 write, 32 destructive.

About DEV Community

DEV Community (dev.to) is a community of software developers where you can publish articles, engage with others, and build your online presence.

Categories: Developer Tools & IT

How to connect DEV Community to Type.com

Access
Organization connection: one shared account for the workspace.
MCP
Selected AI media-generation operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

145 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

145 operations listed.

Agent sessions

  • Read

    list the authenticated user's agent sessions

    Retrieve a list of the authenticated user's agent sessions. Agent Sessions Overview: - Agent sessions represent coding conversation transcripts uploaded from CLI tools (like Claude Code). - Used by the developer portal to render interactive walkthroughs or session summaries.

  • Read

    show details for an agent session

    Retrieve details for a single agent session by unique slug or ID. Integration Tip: - Returns the complete session structure including parsed message logs, token counts, slices, and tool execution metadata.

  • Read

    request a presigned S3 GET URL to download the raw session transcript

    Retrieve a temporary presigned GET URL to download the original raw transcript file from S3.

  • Write

    upload a new agent session

    Upload a new agent session. S3 Upload Workflow: 1. Call the S3 presign endpoint to obtain a direct upload URL for the raw session transcript file. 2. Upload the raw transcript to S3. 3.

  • Write

    request a presigned URL to upload raw session transcript to S3

    Generate an S3 presigned PUT URL and object key for uploading raw session transcripts directly to S3.

Analytics

  • Read

    Retrieve analytics totals

    Retrieve aggregated lifetime stats (views, reactions, comments) for articles. Scope Control: - Specify articleid to query a single post's metrics. - Specify organizationid to retrieve metrics across all articles owned by the target organization.

  • Read

    Retrieve historical analytics

    Retrieve historical analytics data graphed over a time range. Time Range Formats: - start: Start date (e.g. 2024-01-01). Required. - end: End date (e.g. 2024-01-31). Defaults to current date if omitted.

  • Read

    Retrieve analytics for the past day

    Retrieve real-time hourly analytics statistics for the last 24 hours. Used for live graphs.

  • Read

    Retrieve referrer analytics

    Retrieve traffic referring domains and URL source tracking metrics for articles.

  • Read

    Retrieve top contributors analytics

    Retrieve top organization contributors ordered by article engagement scores.

  • Read

    Retrieve follower engagement analytics

    Retrieve stats detailing new follower growth and engagement over time.

  • Read

    Retrieve dashboard analytics bundle

    Retrieve a complete bundled metrics package (totals, history, top posts) for rendering dashboard landing pages.

  • Read

    Retrieve heatmap activity

    Retrieve user activity heatmap metrics (commits, posts, reactions) grouped by weekdays and hours.

Articles

  • Read

    Published articles

    This endpoint allows the client to retrieve a list of articles. "Articles" are all the posts that users create on DEV/Forem that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but are referred to as articles within the code.

  • Read

    Search for articles

    This endpoint allows the client to search for articles. Search Guidance: - q: The search query term. Matches against article titles, tags, and body content. - top: Restricts search results to articles published within the last N days.

  • Read

    Published articles sorted by published date

    This endpoint allows the client to retrieve a list of articles ordered strictly by descending publication date. Usage Tips: - Bypasses all Forem/DEV feed personalization and popularity algorithms. - Ideal for building RSS feeds, chronological timelines, or "latest posts" widgets.

  • Read

    Published article by id

    This endpoint allows the client to retrieve a single published article given its unique numerical id. Integration Tip: - Returns the complete serialized article object including its HTML/markdown representation, tags, and author profile details.

  • Read

    Published article by path

    This endpoint allows the client to retrieve a single published article given its username and slug (the URL-friendly path identifier). Usage Tip: - Handy for resolving absolute Forem/DEV article URLs (e.g., https://dev.to/username/slug) into their corresponding API data models.

  • Read

    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.

  • Read

    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.

  • Read

    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.

  • Read

    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.

  • Write

    Publish article

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

  • Destructive

    Update an article by id

    This endpoint allows the client to update an existing article by its unique numerical id. Authorization Constraints: - The API key provided must belong to the author of the article, an admin of the article's organization, or a site admin.

  • Destructive

    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.

Segments

  • Read

    Manually managed audience segments

    Retrieve a list of manually managed audience segments. Audience Segments Overview: - Audience Segments are cohorts of users grouped together for targeting announcements, features, or promotional campaign banners (Billboards).

  • Read

    A manually managed audience segment

    Retrieve details of a single manually-managed audience segment specified by ID. Integration Tip: - Includes segment type (manual), configuration, and metadata. - Automatic/system-generated segments cannot be queried or updated via this endpoint.

  • Read

    Users in a manually managed audience segment

    Retrieve a paginated list of users enrolled in the specified manual audience segment. Pagination Guidance: - Supports standard page and perpage controls, returning 30 users per page by default.

  • Write

    Create a manually managed audience segment

    Create a new manually managed audience segment. Usage Guidance: - Used by administrators to define a new target cohort group. - Users can be added or removed in bulk later via segment member endpoints.

  • Destructive

    Delete a manually managed audience segment

    Delete an audience segment specified by ID. Constraints: - Audience segments cannot be deleted if they are currently assigned to any active or pending Billboards.

  • Destructive

    Add users to a manually managed audience segment

    Add users in bulk to the specified manual audience segment. Bulk Update Behavior: - Accepts a JSON array of userids in the request body. - Returns a list of successes and failures. Successful additions include users already present in the segment.

  • Destructive

    Remove users from a manually managed audience segment

    Remove users in bulk from the specified manual audience segment. Bulk Update Behavior: - Accepts a JSON array of userids in the request body. - Returns successes (users successfully removed) and failures (users who were not members of the segment).

Badge achievements

  • Read

    Retrieve all badge achievements

    Retrieve a list of all badge achievements (awarded badges) in the system. Requires administrator privileges.

  • Read

    Retrieve a badge achievement's details

    Retrieve details of a specific badge award/achievement by ID.

  • Write

    Create a badge achievement

    Award a badge to a user. Requires administrator privileges. Integration Tips: - userid: The numeric ID of the user receiving the badge. - badgeid: The numeric ID of the badge being awarded.

  • Destructive

    Delete a badge achievement

    Revoke a badge award by deleting the badge achievement. Requires administrator privileges.

Badges

  • Read

    Retrieve all badges

    Retrieve a list of all badges available on the platform. Badges Overview: - Badges recognize achievements (e.g., "Top Writer", "Beloved Community Member", or anniversary milestones). - Publicly visible on user profiles.

  • Read

    Retrieve a badge's details

    Retrieve details of a single badge by unique numeric ID.

  • Write

    Create a badge

    Create a new badge. Requires administrator privileges. Body Parameter Guidelines: - title: Unique name for the badge. - description: Text explanation of the achievement. - remotebadgeimageurl: Public URL to an image asset (PNG, GIF, or SVG) representing the badge icon.

  • Write

    Update a badge

    Update badge details (title, description, credits awarded, etc.) by unique ID. Requires administrator privileges.

  • Destructive

    Delete a badge

    Delete a badge configuration from the system by ID. Requires administrator privileges.

Billboards

  • Read

    Billboards

    Retrieve a list of all billboards configured in the system. Billboards Overview: - Billboards are custom promotional ads, notification banners, or call-to-actions shown on the Forem website. - Requires administrative privileges.

  • Read

    A billboard (by id)

    Retrieve full configurations of a single billboard by ID. Requires admin credentials.

  • Write

    Create a billboard

    Create a new billboard. Parameter Options & Tips: - bodymarkdown: The HTML/Markdown advertisement copy. - placementarea: Target region in layouts (e.g. postcomments below comments, sidebar in sidebars, homefeed between posts). - displayto: Cohort target rules (e.g.

  • Destructive

    Update a billboard by ID

    Update an existing billboard's configurations. Integration Guidance: - Allows changing placement area, geolocations, target segments, or text copy. - Updating an active billboard takes effect instantly in the layout delivery cache.

  • Destructive

    Unpublish a billboard

    Remove a billboard from active rotation by unpublishing it. Usage: - Instantly disables display across all pages while keeping the configuration stored in the database for later reactivations or historical reporting.

Comments

  • Read

    Comments

    This endpoint allows the client to retrieve all comments belonging to an article or podcast episode as threaded conversations. Threaded Structure & Pagination Tips: - Threaded Format: Comments are returned as a tree structure (nested arrays of replies).

  • Read

    Comment by id

    This endpoint allows the client to retrieve a specific comment and all of its nested descendant replies. Integration Tip: - Handy for linking directly to a deep comment thread or loading individual comment replies on demand.

Concepts

  • Read

    Retrieve all accessible concepts

    Retrieve all accessible concepts in the system. Concepts Overview: - Concepts are semantic tags generated automatically by analyzing article text using ML embeddings (gemini-embedding-2), rather than explicit user tags.

  • Read

    Retrieve details of a concept

    Retrieve details, settings, and popularity metrics of a single concept by ID. Integration Tip: - Includes the semantic description, similarity thresholds, parent concept mappings, and scores.

  • Read

    Retrieve articles mapped to a concept

    Retrieve articles classified under this concept. Parameter Guidelines: - sort: Set to score to sort articles by article popularity score descending. If omitted or set to any other value, sorting defaults to cosine similarity (closest first) secondary sorted by article score.

  • Read

    Retrieve all concepts (Admin)

    Retrieve all concepts in the system including system and draft concepts. Admin credentials required.

  • Read

    Retrieve concept detail (Admin)

    Retrieve full details of a specific concept by ID. Admin credentials required.

  • Read

    Perform a semantic fuzzy search on concepts

    Allows authenticated clients to search concepts using Forem's semantic embeddings database.

  • Write

    Update a concept's metadata

    Update concept metadata such as description, similarity threshold, and custom score.

  • Write

    Create a concept (Admin)

    Create a new Concept. Parameters: - name: Human readable label for the concept. - description: Detailed semantic definition used to generate the anchor embedding. - similaritythreshold: Target similarity threshold for categorizing articles under this concept.

  • Write

    Update a concept (Admin)

    Update concept properties. Admin credentials required.

  • Write

    Trigger concept lookback backfill (Admin)

    Trigger a background backfill worker to scan historical articles published in the last N days and evaluate them against this concept.

  • Destructive

    Delete a concept (Admin)

    Permanently delete a concept by ID. Admin credentials required.

Events

  • Read

    Retrieve events

    Retrieve a list of events on the platform. Query Parameters: - typeof: Filter events by their type (livestream, takeover, other, challenge).

  • Read

    Retrieve an event

    Retrieve a single event by ID.

  • Write

    Create an event

    Create a new event. Requires administrator privileges.

  • Write

    Update an event

    Update an existing event. Requires administrator privileges.

  • Destructive

    Delete an event

    Delete an event. Requires administrator privileges.

Feedback messages

  • Write

    Update a feedback message's status (Admin)

    Update the status of a user feedback message or report. Feedback Messages Overview: - Feedback messages are submitted by users via support forms or content abuse reporting modals. - Requires Administrator privileges. - Used to track moderation/resolution workflows (e.g.

Followed tags

  • Read

    Followed Tags

    Retrieve the list of tags followed by the authenticated user. Integration & Personalization Guidance: - Requires authentication. - Returns tags in ascending/popularity order based on user interactions.

Followers

  • Read

    Followers

    This endpoint allows the client to retrieve a list of the followers they have. Integration & Pagination Guidance: - "Followers" are other users registered on the platform who follow the authenticated user. - Supports pagination, defaulting to 80 followers per page.

Follows

  • Write

    Follow users or organizations

    Follow users or organizations in bulk on behalf of the authenticated user. Bulk Update Behavior: - Accepts arrays of userids and organizationids in the request body. - Performs follow actions for all provided identifiers.

Health checks

  • Read

    Check app health

    Basic application liveness check. Usage Guidance: - Verifies that the Rails application process is running and responding to requests. - Does not check database or cache connectivity.

  • Read

    Check database connection

    Database connection health check. Usage Guidance: - Verifies that the application can successfully query the primary PostgreSQL database. - Used to monitor database pool status and connection health.

  • Read

    Check cache connection

    Cache connection health check. Usage Guidance: - Verifies that the application can successfully ping the Redis cache instance. - Used to monitor cache and background worker queue connection health.

Images

  • Write

    upload an image

    Upload an image and get back a URL hosted by this Forem. Using the URL: - Embed it in an article's bodymarkdown, e.g. A description. - Set it as an article's cover image by passing it as mainimage when creating or updating an article.

  • Write

    generate an image with AI

    Generate an image from a text prompt and get back a URL hosted by this Forem. The image follows this Forem's cover image style and, unless aspectratio is given, is sized for its cover images. Use the URL in bodymarkdown or as an article's mainimage, just like an uploaded image.

Instance

  • Read

    Retrieve instance configuration details

    Retrieve configuration details for the current Forem instance. Instance Metadata: - Bypasses authentication. - Returns public Forem version, branding parameters, community guidelines references, and supported features configurations.

Openapi

  • Read

    OpenAPI description

    Retrieve the machine-readable OpenAPI contract for this Forem instance. Automated clients should use this document instead of inferring endpoint schemas from responses or errors.

Organizations

  • Read

    An organization (by username)

    Retrieve public profile information for a single organization by its username. Integration Tip: - Bypasses authentication. - Returns details like Tech Stack, Tagline, Story, website URLs, and joined date.

  • Read

    Organization's users

    Retrieve a list of public user profiles associated with the organization. Path Parameter Options: - organizationidorusername: Supports either the organization's unique numerical ID OR its string username (slug).

  • Read

    Organization's Articles

    Retrieve a list of articles published by the organization. Path Parameter Options: - organizationidorusername: Supports either the organization's unique numerical ID OR its string username (slug). - Returns articles in reverse chronological publication order.

  • Read

    Organizations

    This endpoint allows the client to retrieve a list of Dev organizations. It supports pagination, each page will contain 10 tags by default.

  • Read

    An organization (by id)

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

  • Write

    Create an Organization

    This endpoint allows the client to create an organization with the provided parameters. It requires a token from a user with admin privileges.

  • Destructive

    Update an organization by id

    This endpoint allows the client to update an existing organization.

  • Destructive

    Delete an Organization by id

    This endpoint allows the client to delete a single organization, specified by id

Pages

  • Read

    show details for all pages

    Retrieve details for all Page objects in the system. Pages Overview: - Pages are custom static or dynamic views hosted on the Forem instance. - Publicly visible unless restricted. - Helpful for building custom menus, rendering site policies, or embedding custom forms.

  • Read

    show details for a page

    Retrieve details for a single Page object specified by ID.

  • Write

    pages

    Create a new custom page. Requires site administrative privileges, or organization admin privileges for the specified organizationid (when the organization pages feature is enabled). Body Parameter Guidelines: - title: Heading displayed at the top of the page.

  • Destructive

    update details for a page

    Update an existing page's details by ID. Requires site administrative privileges, or organization admin privileges for pages belonging to an organization.

  • Destructive

    remove a page

    Delete a custom page from the system by ID. Requires site administrative privileges, or organization admin privileges for pages belonging to an organization.

Podcast episodes

  • Read

    Podcast Episodes

    Retrieve a list of podcast episodes published on the platform. Integration Guidance: - Bypasses authentication (can be accessed publicly). - Only returns active episodes belonging to published/reachable podcasts.

Profile images

  • Read

    A Users or organizations profile image

    Retrieve the profile image URL and configuration for a user or organization by username. Integration Details: - Bypasses authentication.

Reactions

  • Write

    toggle reaction

    Toggle a reaction on a target resource (Article, Comment, or User) on behalf of the authenticated user. Toggle Logic: - First Request: Creates a new reaction of the specified category on the reactable target. - Second Request (with same parameters): Deletes the existing reaction.

  • Write

    create reaction

    Create a reaction on a target resource (Article, Comment, or User) on behalf of the authenticated user.

Readinglist

  • Read

    Readinglist

    Retrieve the list of articles saved to the authenticated user's reading list. Integration Guidance: - Requires authentication. - Under the hood, this endpoint retrieves articles that the user has reacted to with the "save" reaction category.

Recommended articles lists

  • Read

    Retrieve all recommended articles lists

    Retrieve a list of all recommended articles lists configured in the system. Overview: - Recommended Articles Lists are curated selections of articles pinned or recommended in layout regions (e.g. mainfeed or sidebar). - Supports search by list name and standard query pagination.

  • Read

    Retrieve details of a recommended articles list

    Retrieve full details and nested article lists for a specific recommended articles list by ID. Requires Admin credentials.

  • Write

    Create or update a recommended articles list

    Create a new recommended articles list or update an existing one. Requires Administrator privileges. Body Parameter Guidelines: - name: Curated list title or label (e.g. "Editor's Choice"). - placementarea: Target UI layout region (e.g. mainfeed, sidebartop, onboarding).

  • Write

    Update a recommended articles list

    Update an existing recommended articles list by ID. Requires Admin credentials.

Request redirects

  • Read

    Retrieve all request redirects (Admin)

    Retrieve a list of all request redirects configured on the platform. Redirects Overview: - Redirects map incoming HTTP request paths or domains to specific target destination URLs (301 or 302 redirects).

  • Read

    Retrieve a request redirect's details (Admin)

    Retrieve details of a single request redirect route by ID. Requires Admin credentials.

  • Write

    Create a request redirect (Admin)

    Create a new request redirect route. Requires Administrator privileges. Body Parameter Guidelines: - originalurl: The source path (e.g. /old-page) to intercept. - destinationurl: The target destination (e.g. https://myforem.com/new-page) to redirect users to.

  • Write

    Update a request redirect (Admin)

    Update details (paths or domain scope) of an existing redirect route by ID. Requires Admin credentials.

  • Destructive

    Delete a request redirect (Admin)

    Delete a request redirect route, disabling the routing intercept immediately. Requires Admin credentials.

Subforems

  • Read

    Retrieve all discoverable subforems

    Retrieve a list of all discoverable subforems/communities. Subforems Overview: - Subforems represent distinct sub-communities or specialized sections hosted within the Forem instance. - Bypasses authentication (can be accessed publicly).

Surveys

  • Read

    List surveys

    Retrieve a list of surveys configured on the platform. Surveys Overview: - Surveys are admin-defined questionnaires consisting of multiple choice or text polls. - Requires Administrator authorization. - Supports standard pagination controls and active status filtering.

  • Read

    A survey with polls

    Retrieve a single survey (by ID or slug) with its nested structure. Nested Format Details: - Returns the target Survey object including all associated Polls, multiple choice options, and configuration states. - Requires Administrator authorization.

  • Read

    Survey poll votes

    Retrieve multiple-choice poll votes for a specific survey. Cursor Pagination Tip: - Uses cursor-based pagination to safely stream high volumes of voting records. - Specify the after query parameter with the last retrieved record ID to get the next page.

  • Read

    Survey poll text responses

    Retrieve free-text poll responses for a specific survey. Integration & Cursor Tip: - Fetches written user answers for text-input questions. - Uses cursor-based pagination (after query param) to stream responses. - Requires Administrator authorization.

  • Write

    Create a survey

    Create a new survey with optional nested polls and poll options. Requires Administrator privileges.

  • Write

    Update a survey

    Update an existing survey, including its polls and options. Requires Administrator privileges.

  • Destructive

    Delete a survey

    Delete an existing survey. Requires Administrator privileges.

Tags

  • Read

    Tags

    Retrieve a list of tags used on the platform, ordered by popularity. Integration Tips: - Bypasses authentication (can be accessed publicly). - Ordered by overall popularity/usage metrics on the platform.

  • Read

    Supported tags

    Retrieve every tag supported on the platform (or current subforem), ordered by popularity. Integration Tips: - Bypasses authentication (can be accessed publicly). - Not paginated: returns the complete list of supported tags in a single response.

  • Destructive

    Update a tag

    Update a tag's display details and wiki by ID. Requires an API key that belongs to a super admin, an admin, or a user with the singleresourceadmin role on Tag. Each update is written to the admin API audit log.

Trends

  • Read

    Trends

    Retrieve a list of active trends. Trends Overview & Score Calculation: - Trends represent hot topics or semantic themes currently being heavily discussed in the community. - They are computed by clustering semantic concept embeddings of recently published articles.

  • Read

    A Trend

    Retrieve details of a single trend using either its numeric ID or unique slug. Usage Guidance: - Useful for loading details of a trending topic (description, score, and slug details) to render header sections on trending tag or topic pages.

  • Read

    Articles in a Trend

    Retrieve a list of published articles belonging to a trend. Article Ordering & Proximity: - Articles are mapped to trends based on their embedding distance to the trend's centroid.

Users

  • Read

    The authenticated user

    Returned only for delegated Bearer tokens, on any Bearer-capable endpoint, when the configured JWKS endpoint cannot be reached or returns an unusable key set and no cached keys remain. Invalid tokens are 401, never 503.

  • Read

    A User

    This endpoint allows the client to retrieve a single user, either by id or by the user's username. Path Parameter Options: - id: Can be either the user's unique numerical ID (e.g. 123) OR the user's string username (e.g. ben).

  • Read

    Search for users

    Search for a user by email address. Permissions & Context: - Requires administrative privileges (api-key of an administrator). - Used to verify account existence or map email addresses to platform usernames.

  • Read

    List all users (Admin)

    Retrieve a list of all users registered on the platform. Permissions & Filters: - Requires Super Admin privileges. - Allows filtering by exact email or username.

  • Read

    Get user detail (Admin)

    Retrieve details of a single user by numerical ID. Super Admin Action: - Requires Super Admin privileges. - Includes administrative settings, audit notes, email newsletter preferences, and OAuth login identity states.

  • Read

    List notes for a user (Admin)

    Retrieve all moderator/administrator audit log notes appended to a user. Requires Super Admin credentials.

  • Read

    List identities for a user (Admin)

    Retrieve all linked OAuth identities (e.g., GitHub, Twitter, Apple) for a user. Requires Super Admin credentials.

  • Write

    Invite a User

    Invite a new user to join the platform by email. Super Admin Action: - Requires Super Admin privileges. - Triggers a system invitation flow and sends an invitation email containing a sign-up link. - Handy for invite-only platforms or private enterprise instances.

  • Write

    Update user profile (Admin)

    Update a user's public profile fields (name, location, bio summary, website) on their behalf. Requires Super Admin credentials.

  • Write

    Merge user into another (Admin)

    Merge a duplicate user account into a target main account. Account Merging Behavior: - Transfers all comments, articles, reactions, and follows to the target user (mergeuserid).

  • Write

    Add a note to a user (Admin)

    Add a new moderation/audit note to a user. Audit Logging Guidelines: - content: Plaintext description of behavior, infraction, or actions taken. - reason: Categorized classification (e.g. spam, abuse, harassment, administrative). - Requires Super Admin credentials.

  • Write

    Link an identity to a user (Admin)

    Manually link an OAuth provider identity to a user. Requires Super Admin credentials. Identity Binding: - provider: The login provider name (e.g. github, twitter). - uid: The provider's unique user identifier. - username: The user's username on the provider's service.

  • Write

    Bulk link identities (Admin)

    Bulk link OAuth identities across multiple users. Requires Super Admin credentials.

  • Destructive

    Suspend a User

    Suspend a user's account. Suspension Details: - The user associated with the API key must have an admin or moderator role. - Assigns the suspended role to the user, preventing them from posting new content (articles or comments) while suspended. - Existing content is not deleted.

  • Destructive

    Add limited role for a User

    Limit a user's account permissions. Limited Details: - Requires admin or moderator privileges. - Assigns the limited role, which rate-limits notifications generated by their actions (such as publishing new posts or comments).

  • Destructive

    Remove limited for a User

    Remove the limited role, restoring the user to general privileges. Requires admin or moderator role.

  • Destructive

    Add spam role for a User

    Flag a user as spammer. Spam Role Details: - Requires admin or moderator privileges. - Stops the user from creating new posts or comments, acting as a shadowban or block on activity. - Existing content remains but is hidden from search/feeds.

  • Destructive

    Remove spam role from a User

    Unflag a user as spammer, restoring general permissions. Requires admin or moderator role.

  • Destructive

    Add trusted role for a User

    Assign the trusted role to a user. Trusted Role Details: - Requires admin or moderator privileges. - Trusted users gain privileges like casting flag votes on inappropriate content or participating in priority review queues.

  • Destructive

    Remove trusted role from a User

    Revoke the trusted role, returning the user to general status. Requires admin or moderator role.

  • Destructive

    Add basesubscriber role for a User

    Assign the basesubscriber role to a user. Base Subscriber Details: - Requires an admin role or the supermoderator role. - Uses the same path as granting "Base Subscriber" in the admin UI: adds the role, adds a note to the user, and sends the user the base subscriber email.

  • Destructive

    Remove basesubscriber role from a User

    Remove the basesubscriber role from a user. Other roles are not changed. Requires an admin role or the supermoderator role.

  • Destructive

    Unpublish a User's Articles and Comments

    This endpoint allows the client to unpublish all of the articles and comments created by a user. Administrative Action: - Requires the authenticated user to be an Administrator.

  • Destructive

    Update user email (Admin)

    Update a user's primary registration email address. Requires Super Admin credentials.

  • Destructive

    Update user moderation status (Admin)

    Manually update a user's moderation status. Status Details: - status: Allowed target states (e.g. active, suspended, banned). - note: Required reason text recorded in the user's moderation log audit history. - Requires Super Admin privileges.

  • Destructive

    Update user notification settings (Admin)

    Update a user's email notification preferences (e.g., unsubscribing them from the system newsletter or the periodic digest). Any subset of the listed properties may be supplied; at least one is required. Requires Super Admin credentials.

  • Destructive

    Unlink an identity from a user (Admin)

    Unlink a specific OAuth login provider identity from a user by identity ID. Requires Super Admin credentials.

Videos

  • Read

    Articles with a video

    Retrieve a list of articles that contain uploaded videos. Videos Overview: - Bypasses authentication (can be accessed publicly). - Returns articles that are published and include a video asset. - Articles are ordered by descending popularity (views, watch time, and reactions).

See How connections work for access and permissions, or browse all integrations.

Reference date: October 27, 2026. DEV Community API docs.