Skip to content

Wellesley Platform API (1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.wellesley.social/_mock/openapi/
Simple setup, all in one. Digital Ocean
https://dust.allroads.social/
Simple setup, db is separate. Digital Ocean
https://meteor.allroads.social/

AI Agents

Assign and list group AI agent assignments

Operations

Accounts

Account management and authentication endpoints. Handles user registration, login flows (email/phone), profile management, and account lifecycle operations. Supports multi-step signup with email/SMS verification, CAPTCHA, and optional admin approval.

Operations

ActivityPub

WebFinger endpoint for ActivityPub user discovery and federation

Addresses

Endpoints for suggesting and validating physical addresses

Operations

Admin

Development and testing endpoints for populating the database with test data

Admin Accounts

Administrative endpoints for account and user management. Provides comprehensive tools for managing user accounts, including creation, deletion, role assignment, password management, state changes, and user impersonation for bot accounts.

Operations

Admin ActivityPub

Administrative endpoints for ActivityPub

Operations

Admin Audit

Administrative endpoints for viewing and managing audit logs. Provides comprehensive logging of all security-relevant actions performed in the system.

Operations

Admin Domain Blocks

Administrative APIs for managing domain blocks. Provides endpoints to block specific domains with different severity levels (SUSPEND, LIMIT, NOOP), update existing blocks, unblock domains, and list currently blocked domains. Domain blocks prevent or limit federation with specified domains.

Operations

Admin Domains Allow List

Administrative endpoints for managing domain allowlists. When domain allowlisting is enabled, only domains in this list can federate with the instance.

Operations

Admin Email Allow List

Administrative endpoints for managing email domain allowlist used for registrations.

Operations

Admin Email Blocks

Administrative APIs for managing email blocks to prevent unwanted signups. Supports blocking specific email addresses and entire domains. Email blocks are automatically normalized and checked during user registration.

Operations

Admin Federation Metrics

Administrative endpoints for monitoring and managing federation with other ActivityPub instances. Provides metrics on connected domains, user counts, post statistics, and federation health monitoring.

Operations

Admin Feeds

Administrative endpoints for managing user feeds and cache

Operations

Admin Groups

Administrative endpoints for Groups management

Operations

Admin Init

Administration endpoints for system initialization and updates

Admin Posts

Administrative endpoints for managing posts. Provides moderation capabilities to delete posts that violate community guidelines or are part of reported content.

Operations

Admin Reports

Administrative endpoints for managing user reports and moderation. Provides tools for reviewing, assigning, resolving, and annotating reports about users, posts, and groups. Supports workflow management with assignment, notes, and resolution tracking.

Operations

Admin Signup Requests

Administrative endpoints for managing user signup requests. Provides tools for reviewing, approving, rejecting, and managing signup requests in moderation queue. Supports workflow for manual account approval when enabled.

Operations

Admin Uploads

Administrative endpoints for managing file uploads and media storage. Provides tools for monitoring user storage usage, searching uploaded files, and managing upload processing jobs. Supports queue management for async upload processing workflows.

Operations

Aliases

Endpoints for managing previous usernames and username aliases

Operations

Application Data

Endpoints for managing application-specific data storage. Provides a flexible key-value storage system for applications to store custom data associated with users, groups, or the platform. Supports tagging, filtering, and ownership-based access control.

Operations

Applications

Endpoints for serving and routing platform applications to users

Operations

Blocks

User blocking functionality for preventing interaction with specific users. Blocking a user prevents them from following you, seeing your posts, or interacting with your content. Block operations are federated to remote servers when blocking remote users.

Operations

Categories

Endpoints for managing forum-specific categories

Operations

Domain Blocks

Public API for listing domains blocked by this instance. Visibility and reason details are controlled by platform settings.

Operations

Domain-blocks

Endpoints for managing user-level domain blocks to filter content from specific servers

Operations

Drafts

Endpoints for creating, reading, updating, and deleting drafts, as well as publishing them to posts

Operations

Email

Email address management for user accounts. Provides secure email change workflow with verification codes, password confirmation, and notification system. All email changes require authentication and are logged for security.

Operations

Emoji

Custom emoji management system for the platform. Supports creating, uploading, importing/exporting, searching, and deleting custom emojis. Emojis are automatically resized and optimized. Admin-only operations require Emojis.Manage permission.

Operations

Events

Endpoints for creating, retrieving, and managing events and attendees

Operations

Events ActivityPub

ActivityPub-compatible endpoint for events

Follow

User follow relationship management. Handles following/unfollowing users, managing follow requests, and querying follower/followee relationships. Supports both local and remote (federated) users with ActivityPub protocol integration.

Operations

Forums

Endpoints for managing discussion forums, including creation, retrieval, and deletion

Operations

Geo

Endpoints for geographic location lookup and timezone services

Operations

Group Applications

Endpoints for managing applications available to groups, including listing, adding, and removing group-specific applications

Operations

Group Channels

API endpoints for managing channels within groups. Channels are specialized accounts that enable organized content distribution within groups. They support hierarchical organization with main and default channels, privacy controls inherited from parent groups, and both scoped (group-specific) and global usernames for discovery. Group administrators manage channels while members can follow them.

Operations

Group Member Settings

Endpoints for managing member-specific settings within groups. These settings are personal to each group member and affect their individual experience within the group. Members can only access and modify their own settings within groups they belong to.

Operations

Group Members

API endpoints for managing group membership. Provides functionality to add, update, and remove members from groups, as well as retrieve membership information. Supports both local and federated groups through ActivityPub protocol. Access control is enforced based on group privacy settings and user permissions.

Operations

Group Questions

API endpoints for managing group entry questions. Groups can require prospective members to answer questions before joining. Questions support multiple types (text, single choice, multiple choice) and are used to screen members when the group's join mode is set to QUESTIONS. Answers are validated and generate a token that can be used during the join process.

Operations

Group Reports

Group-scoped moderation reports. Allows group admins to review and resolve reports targeting their channels, forums, and events without global moderator access.

Operations

Group Rules

API endpoints for managing community rules within groups. Rules define the expected conduct and content policies that members must follow. Each rule consists of text (the rule itself), a hint (explanation or context), and an ordering value for display sequence. Rules are scoped to specific groups and can be managed by users with appropriate permissions.

Operations

Group Settings

Endpoints for managing group-specific settings and configuration options. These endpoints allow authorized group members to view, update, and delete settings that control group behavior, features, and customization options.

Operations

Groups

API endpoints for managing groups within the Wellesley platform. Groups are community spaces that can be public or private, support forums, and have their own membership and permission systems. Groups can be federated via ActivityPub for cross-instance communication.

Operations

Import

Endpoints for importing data from other platforms including followers, blocks, and mutes

Operations

Instance

Server instance information and configuration. Provides metadata about the server, compatible domains, supported languages, timezones, and countries. All endpoints are publicly accessible without authentication.

Operations

Invites

Endpoints for sending and managing user invitations

Operations

Jobs

Endpoints for monitoring and managing background job queues, including statistics, job listings, and queue monitoring

Operations

Lists

Endpoints for managing user lists for organizing and grouping followed accounts

Operations

Logins

Endpoints for managing user login methods including email, password, and phone authentication

Operations

Metrics

Endpoints for retrieving metrics and analytics data from the events stream

Operations

Mutes

Endpoints for managing user mutes to hide content from specific users

Operations

Notes

Endpoints for managing personal notes about other users

Operations

Notifications

Endpoints for managing user notifications including retrieving, counting, and marking notifications as read or unread

Operations

Returns user's notifications

Request

Retrieves the user's notifications with filtering options for types, excludeTypes and status

Security
header
Query
excludeTypesArray of strings or null(NotificationType)
Enum"FOLLOW""FOLLOW_REQUEST""GROUP_INVITE""LIKE""COMMENT""MENTION""REPOST""LIST_POST_CREATE""POST_UPDATE""POLL"
lastIdstring or null

Get older records (records with IDs less than this value) Alias maxId/max_id

Example: lastId=?lastId=${data.last().id}
limitinteger or null(int32)
offsetinteger or null(int32)
sortBystring or null
sortOrderstring or null
statusstring or null
Enum"UNREAD""READ""BLOCKED""HIDDEN"
typesArray of strings or null(NotificationType)
Enum"FOLLOW""FOLLOW_REQUEST""GROUP_INVITE""LIKE""COMMENT""MENTION""REPOST""LIST_POST_CREATE""POST_UPDATE""POLL"
untilIdstring or null

Get newer records (records with IDs greater than this value) Alias minId/min_id

Example: untilId=?untilId=${data.first().id}
htmlContentany

Returns text as html if true or original text if false. Applicable only to local posts and users. Default is true.

curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/notifications?excludeTypes=FOLLOW&lastId=%3FlastId%3D%24{data.last%28%29.id}&limit=0&offset=0&sortBy=string&sortOrder=string&status=UNREAD&types=FOLLOW&untilId=%3FuntilId%3D%24{data.first%28%29.id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Notifications

Bodyapplication/jsonArray [
idstringrequired

Internal notification id

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
userIdstringrequired

User receiving the notification

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
typestring(NotificationType)required

FOLLOW New follower

Send to the user who got a new follower.

FOLLOW_REQUEST New follower request

Similar to FOLLOW, send to the user who got a new follower, but in cases where followers need to be explicitly approved.

GROUP_INVITE User got an invitation

Send to the user who received the ActivityPub invitation activity.

LIKE Post has been liked

Send to the post's author as soon as another user likes their post.

COMMENT Post has been commented on

Send to the post's author and all users subscribed to the post.

MENTION User has been mentioned in a post or comment

Send to the user who was mentioned in the post or comment.

REPOST Post has been reposted

Send to the author of the post that was reposted.

LIST_POST_CREATE New post or comment in list

Send to the list owner when a new post is created by a list user.

POST_UPDATE Post or comment has been updated

Send to users subscribed to the post or comment.

POLL Poll has been closed (expired)

Send to the poll's author and all voters.

EVENT_INVITE User has been invited to a private event

Send to the invitee, i.e., the user invited to the event.

EVENT_REVOKE User's invitation has been revoked

Send to the invitee, i.e., the user whose invitation was revoked.

EVENT_JOIN User joined a public event

Send to the event organizer.

EVENT_CANCEL Event has been cancelled

Send to all event attendees (for public events, to users who joined).

EVENT_UPDATE Event has been updated

Send to all event attendees (for public events, to users who joined).

Enum"FOLLOW""FOLLOW_REQUEST""GROUP_INVITE""LIKE""COMMENT""MENTION""REPOST""LIST_POST_CREATE""POST_UPDATE""POLL"
statusstring(NotificationStatus)required
Enum"UNREAD""READ""BLOCKED""HIDDEN"
activityIdstring or null

Related activity id (usually a post)

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
fromUserIdstring or null

User who triggered the notification

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
metaobject(NotificationMeta)required
meta.​actionsAvailableArray of objects or null(NotificationAction)
meta.​actionsTakenArray of objects or null(NotificationAction)
meta.​emptyboolean
createdAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
updatedAtstring or null(date-time)
Example: "2022-03-10T16:15:50Z"
fromUserobject or null

One of account's users. Can be multiple per account

postobject or null

User's post

]
Response
application/json
[
  {
    "id": "nt_01hz1f0sj42k87a6s2nzpc4s92n",
    "userId": "us_01hz1fkfg82hf89s2nzqwer02r",
    "type": "FOLLOW",
    "status": "UNREAD",
    "activityId": "pt_01hz1f0jkdw3h27a2kdr8sn2kt",
    "fromUserId": "us_01hz1frg9sf48d7a8sn2kdr8w3h",
    "meta": { … },
    "createdAt": "2022-03-10T16:15:50Z",
    "updatedAt": "2022-03-10T16:15:50Z",
    "fromUser": { … },
    "post": { … }
  }
]

Returns notifications count

Request

Gets the count of user's notifications with filtering options for types, excludeTypes and status

Security
header
Query
excludeTypesArray of strings or null(NotificationType)
Enum"FOLLOW""FOLLOW_REQUEST""GROUP_INVITE""LIKE""COMMENT""MENTION""REPOST""LIST_POST_CREATE""POST_UPDATE""POLL"
statusstring or null
Enum"UNREAD""READ""BLOCKED""HIDDEN"
typesArray of strings or null(NotificationType)
Enum"FOLLOW""FOLLOW_REQUEST""GROUP_INVITE""LIKE""COMMENT""MENTION""REPOST""LIST_POST_CREATE""POST_UPDATE""POLL"
curl -i -X GET \
  'https://docs.wellesley.social/_mock/openapi/api/v1/notifications/count?excludeTypes=FOLLOW&status=UNREAD&types=FOLLOW' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
integer
Response
application/json
0

Mark all notifications as read/unread

Request

Updates the status of all notifications for the authenticated user to either read or unread

Security
header
Query
statusstring(NotificationStatus)required
Enum"UNREAD""READ""BLOCKED""HIDDEN"
curl -i -X POST \
  'https://docs.wellesley.social/_mock/openapi/api/v1/notifications/mark-all?status=UNREAD' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Number of notifications changed

Bodyapplication/json
integer
Response
application/json
0

Returns user's notification by id

Request

Retrieves a specific notification by its ID for the authenticated user

Security
header
Path
idstring(TypeId)required

Notification id

Example: us_01hxcvk1hjexere4pvtrj0ymqq
Query
htmlContentany

Returns text as html if true or original text if false. Applicable only to local posts and users. Default is true.

curl -i -X GET \
  https://docs.wellesley.social/_mock/openapi/api/v1/notifications/us_01hxcvk1hjexere4pvtrj0ymqq \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Notification

Bodyapplication/json
idstringrequired

Internal notification id

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
userIdstringrequired

User receiving the notification

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
typestring(NotificationType)required

FOLLOW New follower

Send to the user who got a new follower.

FOLLOW_REQUEST New follower request

Similar to FOLLOW, send to the user who got a new follower, but in cases where followers need to be explicitly approved.

GROUP_INVITE User got an invitation

Send to the user who received the ActivityPub invitation activity.

LIKE Post has been liked

Send to the post's author as soon as another user likes their post.

COMMENT Post has been commented on

Send to the post's author and all users subscribed to the post.

MENTION User has been mentioned in a post or comment

Send to the user who was mentioned in the post or comment.

REPOST Post has been reposted

Send to the author of the post that was reposted.

LIST_POST_CREATE New post or comment in list

Send to the list owner when a new post is created by a list user.

POST_UPDATE Post or comment has been updated

Send to users subscribed to the post or comment.

POLL Poll has been closed (expired)

Send to the poll's author and all voters.

EVENT_INVITE User has been invited to a private event

Send to the invitee, i.e., the user invited to the event.

EVENT_REVOKE User's invitation has been revoked

Send to the invitee, i.e., the user whose invitation was revoked.

EVENT_JOIN User joined a public event

Send to the event organizer.

EVENT_CANCEL Event has been cancelled

Send to all event attendees (for public events, to users who joined).

EVENT_UPDATE Event has been updated

Send to all event attendees (for public events, to users who joined).

Enum"FOLLOW""FOLLOW_REQUEST""GROUP_INVITE""LIKE""COMMENT""MENTION""REPOST""LIST_POST_CREATE""POST_UPDATE""POLL"
statusstring(NotificationStatus)required
Enum"UNREAD""READ""BLOCKED""HIDDEN"
activityIdstring or null

Related activity id (usually a post)

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
fromUserIdstring or null

User who triggered the notification

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
metaobject(NotificationMeta)required
meta.​actionsAvailableArray of objects or null(NotificationAction)
meta.​actionsTakenArray of objects or null(NotificationAction)
meta.​emptyboolean
createdAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
updatedAtstring or null(date-time)
Example: "2022-03-10T16:15:50Z"
fromUserobject or null

One of account's users. Can be multiple per account

postobject or null

User's post

Response
application/json
{
  "id": "nt_01hz1f0sj42k87a6s2nzpc4s92n",
  "userId": "us_01hz1fkfg82hf89s2nzqwer02r",
  "type": "FOLLOW",
  "status": "UNREAD",
  "activityId": "pt_01hz1f0jkdw3h27a2kdr8sn2kt",
  "fromUserId": "us_01hz1frg9sf48d7a8sn2kdr8w3h",
  "meta": {
    "actionsAvailable": [ … ],
    "actionsTaken": [ … ],
    "empty": true
  },
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z",
  "fromUser": {
    "groupUserName": "string",
    "id": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "username": "john_smith",
    "domain": "wlsly1.net",
    "displayName": "John Smith",
    "uri": "https://wlsly1.net/users/john_smith",
    "avatar": { … },
    "createdAt": "2022-03-10T16:15:50Z",
    "deleted": true,
    "state": "REGULAR",
    "relationship": { … },
    "channel": true,
    "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "groupPrivacy": "PUBLIC",
    "groupMain": true,
    "groupDefault": true,
    "actorType": "Application"
  },
  "post": {
    "id": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "uri": "http://example.com",
    "text": "string",
    "path": [ … ],
    "privacy": "PUBLIC",
    "kind": "Note",
    "software": "wellesley",
    "repostOf": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "ownerId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "ownerType": "USER",
    "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "title": "string",
    "summary": "string",
    "tags": [ … ],
    "mentions": [ … ],
    "stats": { … },
    "settings": { … },
    "lang": "BG",
    "poll": { … },
    "card": { … },
    "mediaType": "TEXT_PLAIN",
    "translations": { … },
    "createdAt": "2022-03-10T16:15:50Z",
    "updatedAt": "2022-03-10T16:15:50Z",
    "author": { … },
    "uploads": [ … ],
    "liked": true,
    "reposted": true,
    "quoted": true,
    "muted": true,
    "blocked": true,
    "visible": true,
    "pinned": true,
    "bookmarked": true,
    "edited": true,
    "deleted": true,
    "emojis": [ … ],
    "replies": [ … ],
    "repostedBy": [ … ],
    "originalPost": {},
    "votes": { … },
    "remote": true,
    "repostAny": true,
    "repost": true,
    "quote": true,
    "own": true,
    "replyTo": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "conversationId": "us_01hxcvk1hjexere4pvtrj0ymqq"
  }
}

Mark notification as read/unread by id

Request

Updates the status of a specific notification to either read or unread

Security
header
Path
idstring(TypeId)required

Notification id

Example: us_01hxcvk1hjexere4pvtrj0ymqq
Query
statusstring(NotificationStatus)required
Enum"UNREAD""READ""BLOCKED""HIDDEN"
htmlContentany

Returns text as html if true or original text if false. Applicable only to local posts and users. Default is true.

curl -i -X POST \
  'https://docs.wellesley.social/_mock/openapi/api/v1/notifications/us_01hxcvk1hjexere4pvtrj0ymqq/mark?status=UNREAD' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Notification

Bodyapplication/json
idstringrequired

Internal notification id

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
userIdstringrequired

User receiving the notification

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
typestring(NotificationType)required

FOLLOW New follower

Send to the user who got a new follower.

FOLLOW_REQUEST New follower request

Similar to FOLLOW, send to the user who got a new follower, but in cases where followers need to be explicitly approved.

GROUP_INVITE User got an invitation

Send to the user who received the ActivityPub invitation activity.

LIKE Post has been liked

Send to the post's author as soon as another user likes their post.

COMMENT Post has been commented on

Send to the post's author and all users subscribed to the post.

MENTION User has been mentioned in a post or comment

Send to the user who was mentioned in the post or comment.

REPOST Post has been reposted

Send to the author of the post that was reposted.

LIST_POST_CREATE New post or comment in list

Send to the list owner when a new post is created by a list user.

POST_UPDATE Post or comment has been updated

Send to users subscribed to the post or comment.

POLL Poll has been closed (expired)

Send to the poll's author and all voters.

EVENT_INVITE User has been invited to a private event

Send to the invitee, i.e., the user invited to the event.

EVENT_REVOKE User's invitation has been revoked

Send to the invitee, i.e., the user whose invitation was revoked.

EVENT_JOIN User joined a public event

Send to the event organizer.

EVENT_CANCEL Event has been cancelled

Send to all event attendees (for public events, to users who joined).

EVENT_UPDATE Event has been updated

Send to all event attendees (for public events, to users who joined).

Enum"FOLLOW""FOLLOW_REQUEST""GROUP_INVITE""LIKE""COMMENT""MENTION""REPOST""LIST_POST_CREATE""POST_UPDATE""POLL"
statusstring(NotificationStatus)required
Enum"UNREAD""READ""BLOCKED""HIDDEN"
activityIdstring or null

Related activity id (usually a post)

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
fromUserIdstring or null

User who triggered the notification

Example: "us_01hxcvk1hjexere4pvtrj0ymqq"
metaobject(NotificationMeta)required
meta.​actionsAvailableArray of objects or null(NotificationAction)
meta.​actionsTakenArray of objects or null(NotificationAction)
meta.​emptyboolean
createdAtstring(date-time)(Instant)required
Example: "2022-03-10T16:15:50Z"
updatedAtstring or null(date-time)
Example: "2022-03-10T16:15:50Z"
fromUserobject or null

One of account's users. Can be multiple per account

postobject or null

User's post

Response
application/json
{
  "id": "nt_01hz1f0sj42k87a6s2nzpc4s92n",
  "userId": "us_01hz1fkfg82hf89s2nzqwer02r",
  "type": "FOLLOW",
  "status": "UNREAD",
  "activityId": "pt_01hz1f0jkdw3h27a2kdr8sn2kt",
  "fromUserId": "us_01hz1frg9sf48d7a8sn2kdr8w3h",
  "meta": {
    "actionsAvailable": [ … ],
    "actionsTaken": [ … ],
    "empty": true
  },
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z",
  "fromUser": {
    "groupUserName": "string",
    "id": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "username": "john_smith",
    "domain": "wlsly1.net",
    "displayName": "John Smith",
    "uri": "https://wlsly1.net/users/john_smith",
    "avatar": { … },
    "createdAt": "2022-03-10T16:15:50Z",
    "deleted": true,
    "state": "REGULAR",
    "relationship": { … },
    "channel": true,
    "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "groupPrivacy": "PUBLIC",
    "groupMain": true,
    "groupDefault": true,
    "actorType": "Application"
  },
  "post": {
    "id": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "uri": "http://example.com",
    "text": "string",
    "path": [ … ],
    "privacy": "PUBLIC",
    "kind": "Note",
    "software": "wellesley",
    "repostOf": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "ownerId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "ownerType": "USER",
    "groupId": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "title": "string",
    "summary": "string",
    "tags": [ … ],
    "mentions": [ … ],
    "stats": { … },
    "settings": { … },
    "lang": "BG",
    "poll": { … },
    "card": { … },
    "mediaType": "TEXT_PLAIN",
    "translations": { … },
    "createdAt": "2022-03-10T16:15:50Z",
    "updatedAt": "2022-03-10T16:15:50Z",
    "author": { … },
    "uploads": [ … ],
    "liked": true,
    "reposted": true,
    "quoted": true,
    "muted": true,
    "blocked": true,
    "visible": true,
    "pinned": true,
    "bookmarked": true,
    "edited": true,
    "deleted": true,
    "emojis": [ … ],
    "replies": [ … ],
    "repostedBy": [ … ],
    "originalPost": {},
    "votes": { … },
    "remote": true,
    "repostAny": true,
    "repost": true,
    "quote": true,
    "own": true,
    "replyTo": "us_01hxcvk1hjexere4pvtrj0ymqq",
    "conversationId": "us_01hxcvk1hjexere4pvtrj0ymqq"
  }
}

Passkeys

Passkey (WebAuthn) registration and authentication

Operations

Password

Endpoints for password management including changing, resetting, and recovering passwords

Operations

Pins

Endpoints for pinning posts to profiles and retrieving pinned posts

Operations

Platform Data

Endpoints for managing platform-wide and group-specific data storage. Unlike application data, this provides direct data management not tied to specific applications. Supports flexible ownership models including platform-level, group-level, and user-level data with appropriate access controls.

Operations

Platform Settings

Endpoints for managing platform-wide settings and configuration options. These endpoints control server-level settings that affect the entire platform, including features, limits, security policies, and default behaviors for all users and groups.

Operations

Polls

Endpoints for interacting with polls, including voting and retrieving results

Operations

Posts

Endpoints for creating, reading, updating, and deleting posts, as well as managing comments, likes, bookmarks, and reposts

Operations

RBAC

Endpoints for retrieving Role-Based Access Control (RBAC) configurations and managing roles, resources, permissions and role-to-user assignments. Scoped Role Definition (RBACRole):

  • Represents roles within the RBAC system.
  • Each role has a unique roleId, a name, an optional description, and a scope.
  • The scope defines the domain or area in which the role is valid.
  • The scope can be Global (hardcoded), currently the only one is "System"
  • The scope also can be dynamic, currently we use Group Ids, like "gr_05hxcvk1hjexere4pvtrj0hggt"
  • Roles come with assigned permissions (RBACPermissions) that define what actions the role can perform on system resources.
  • Metadata such as createdAt and updatedAt timestamps track the role's lifecycle events.

Permissions** (RBACPermissions):

  • Encapsulates resource-specific access controls.
  • Each permission object specifies the resource (e.g., "user", "document") and an associated list of allowed RBACAccess types.
  • RBACAccess enumerates the supported actions: Read, Add, Modify, Delete.

Role Assignments to Actors (RBACActorRole):

  • Maps actors (e.g., users, services) to specific roles.
  • Tracks the association through actorId (representing the unique entity being assigned) and roleId (specific role ID).
  • Includes timestamps to record when the assignment was created or updated.
Operations

Remote collections

API to retrieve followers and following collections for remote users.

Operations

Reports

Endpoints for reporting content and managing content reports

Operations

Rules

Endpoints for managing platform rules that govern user conduct and content policies

Operations

Sessions

Endpoints for managing user authentication sessions and device logins

Operations

Tags

Endpoints for managing hashtags, including following, featuring, and retrieving tag information

Operations

Tags v2

Scoped tags search, policy lists and reports

Operations

Translation

Endpoints for translating text between languages

Operations

Uploads

Endpoints for uploading, retrieving, and managing media files

Operations

User Devices

APIs for managing user devices for push notifications

Operations

User Settings

Endpoints for managing user-specific settings and preferences. These endpoints allow authenticated users to view, update, and delete their personal settings that control their account behavior, interface preferences, privacy options, and feature customizations.

Operations

Users

Endpoints for managing user profiles, including creation, retrieval, updates, and moderation

Operations

employee

Employee. DO NOT USE, SUBJECT TO CHANGE/REMOVE

employer

Employer. DO NOT USE, SUBJECT TO CHANGE/REMOVE

job-applications

Jobs. DO NOT USE, SUBJECT TO CHANGE/REMOVE

job-postings

Jobs. DO NOT USE, SUBJECT TO CHANGE/REMOVE

phone

Phone management

Operations

Fasp Resource

Operations

Debug Resource

Operations

Test Authenticated Controller

Operations

Test Class Auth Controller

Operations

Test Class Authenticated Controller

Operations

Test Class Permit All Controller

Operations

Test Permit All Controller

Operations

Test Authorization Controller

Operations

Quarkus Test Resource For Transaction

Operations