lotide API (dev)

Download OpenAPI specification:Download

Look up a remote actor by WebFinger or ActivityPub ID

path Parameters

remoteID

required

string

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"type": "community"
}
]

Fetch a comment

Authorizations:

bearer

path Parameters

commentID

required

integer

query Parameters

include_your	boolean
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"remote_url": "string",
"content_text": "string",
"content_html": "string",
"sensitive": true,
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"deleted": true,
"replies": {"items": [ ],
"next_page": "string"
},
"your_vote": { },
"parent": {"id": 0
},
"post": {"id": 0,
"title": "string",
"remote_url": "string",
"sensitive": true
}
}

Delete a comment

Authorizations:

bearer

path Parameters

commentID

required

integer

Responses

List comment replies

path Parameters

commentID

required

integer

query Parameters

include_your	boolean
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.
depth	integer Number of levels to expand replies for. Defaults to 3.
limit	integer
sort	string (SortType) Enum: "hot" "new"
page	string

Responses

Response samples

200

Content type

application/json

{"items": [{"id": 0,
"remote_url": "string",
"content_text": "string",
"content_markdown": "string",
"content_html": "string",
"sensitive": true,
"attachments": [{"url": "string"
}
],
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"deleted": true,
"local": true,
"replies": {"items": [{ }
],
"next_page": "string"
},
"your_vote": { }
}
],
"next_page": "string"
}

Reply to a comment

path Parameters

commentID

required

integer

Request Body schema: application/json

content_text	string
content_markdown	string
attachment	string Must be a `local-media://` reference
sensitive	boolean

Responses

Request samples

Payload

Content type

application/json

{"content_text": "string",
"content_markdown": "string",
"attachment": "string",
"sensitive": true
}

Response samples

200

Content type

application/json

{"id": 0,
"post": {"id": 0
}
}

List likers of a comment

path Parameters

commentID

required

integer

query Parameters

page

required

string

Responses

Response samples

200

Content type

application/json

{"items": [{"user": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
}
}
],
"next_page": "string"
}

Like a comment

Authorizations:

bearer

path Parameters

commentID

required

integer

Responses

Retract a like of a comment

Authorizations:

bearer

path Parameters

commentID

required

integer

Responses

List communities

Authorizations:

bearer

query Parameters

include_your	boolean If true, will include `you_are_moderator` and `your_follow` in list. Requires login.
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.
search	string
your_follow.accepted	boolean Filter to either communities you are following or waiting to follow. Requires login.
you_are_moderator	boolean Filter based on whether you are a moderator of the community. Requires login.
local	boolean Filter to either local or remote communities.
limit	integer
page	string
sort	string Enum: "old_local" "alphabetic"

Responses

Response samples

200

Content type

application/json

{"items": [{"description": {"content_text": "string",
"content_markdown": "string",
"content_html": "string"
},
"feeds": {"atom": {"new": "string"
}
},
"you_are_moderator": true,
"your_follow": {"accepted": true
},
"pending_moderation_actions": 0,
"id": 0,
"name": "string",
"local": true,
"host": "string",
"remote_url": "string",
"deleted": true
}
],
"next_page": "string"
}

Create a community

Authorizations:

bearer

Request Body schema: application/json

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"community": {"id": 0
}
}

Fetch community info

Authorizations:

bearer

path Parameters

communityID

required

integer

query Parameters

include_your	boolean
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.

Responses

Response samples

200

Content type

application/json

{"description": {"content_text": "string",
"content_markdown": "string",
"content_html": "string"
},
"feeds": {"atom": {"new": "string"
}
},
"you_are_moderator": true,
"your_follow": {"accepted": true
},
"pending_moderation_actions": 0,
"id": 0,
"name": "string",
"local": true,
"host": "string",
"remote_url": "string",
"deleted": true
}

Edit community details

Authorizations:

bearer

path Parameters

communityID

required

integer

Request Body schema: application/json

description_text	string
description_markdown	string
description_html	string

Responses

Request samples

Payload

Content type

application/json

{"description_text": "string",
"description_markdown": "string",
"description_html": "string"
}

Delete a community

Authorizations:

bearer

path Parameters

communityID

required

integer

Responses

Follow a community

Authorizations:

bearer

path Parameters

communityID

required

integer

Request Body schema: application/json

try_wait_for_accept

boolean

If true, will wait before responding to give the remote server time to accept the follow

Responses

Request samples

Payload

Content type

application/json

{"try_wait_for_accept": true
}

Response samples

200

Content type

application/json

{"accepted": true
}

List moderators of a community

path Parameters

communityID

required

integer

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
}
]

Add a moderator to a community

Authorizations:

bearer

path Parameters

communityID required	integer
userID required	integer

Responses

Remove a moderator from a community

Authorizations:

bearer

path Parameters

communityID required	integer
userID required	integer

Responses

List community modlog events

path Parameters

communityID

required

integer

query Parameters

limit	integer
page	string

Responses

Response samples

200

Content type

application/json

{"items": [{"time": "2019-08-24T14:15:22Z",
"type": "reject_post",
"post": {"id": 0,
"title": "string",
"remote_url": "string",
"sensitive": true
}
}
],
"next_page": "string"
}

Modify a post's publishing state

path Parameters

communityID required	integer
postID required	integer

Request Body schema: application/json

approved	boolean
sticky	boolean

Responses

Request samples

Payload

Content type

application/json

{"approved": true,
"sticky": true
}

Unfollow a community

Authorizations:

bearer

path Parameters

communityID

required

integer

Responses

Get database connection status

Responses

Response samples

200

Content type

application/json

{"pool": {"max": 0,
"size": 0,
"idle": 0,
"waiting": 0
}
}

List flags

query Parameters

to_community	integer
to_this_site_admin	boolean
dismissed	boolean Filter by whether the flag is dismissed for the target. Requires exactly one target filter.
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.

Responses

Response samples

200

Content type

application/json

{"items": [{"id": 0,
"flagger": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
},
"created_local": "2019-08-24T14:15:22Z",
"content": {"content_text": "string"
},
"type": "post",
"post": {"id": 0,
"title": "string",
"remote_url": "string",
"href": "string",
"content_text": "string",
"content_html": "string",
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"community": {"id": 0,
"name": "string",
"local": true,
"host": "string",
"remote_url": "string"
},
"score": 0,
"sticky": true,
"your_vote": { },
"content_markdown": "string",
"sensitive": true,
"replies_count_total": 0
}
}
],
"next_page": "string"
}

Edit flag details

path Parameters

flagID

required

integer

Request Body schema: application/json

community_dismissed

boolean

Responses

Request samples

Payload

Content type

application/json

{"community_dismissed": true
}

Request a password reset

Request Body schema: application/json

email_address

required

string <email>

Responses

Request samples

Payload

Content type

application/json

{"email_address": "user@example.com"
}

Check validity of a password reset key

path Parameters

key

required

string

Responses

Reset a password using a password reset key

path Parameters

key

required

string

Request Body schema: application/json

new_password

required

string <password>

Responses

Request samples

Payload

Content type

application/json

{"new_password": "pa$$word"
}

Fetch information about the instance

query Parameters

image_handling

string

Enum: "remove" "preserve" "convert_to_links"

What to do with inline images in HTML content. Defaults to convert_to_links.

Responses

Response samples

200

Content type

application/json

{"software": {"name": "lotide",
"version": "0.5.0-pre"
},
"description": {"content_text": "string",
"content_markdown": "string",
"content_html": "string"
},
"web_push_vapid_key": "string",
"signup_allowed": true,
"invitations_enabled": true,
"community_creation_requirement": "site_admin",
"invitation_creation_requirement": "site_admin"
}

Modify instance settings

Request Body schema: application/json

description_text	string
description_markdown	string
description_html	string
signup_allowed	boolean
invitations_enabled	boolean
community_creation_requirement	string or null Value: "site_admin"
invitation_creation_requirement	string or null Value: "site_admin"

Responses

Request samples

Payload

Content type

application/json

{"description_text": "string",
"description_markdown": "string",
"description_html": "string",
"signup_allowed": true,
"invitations_enabled": true,
"community_creation_requirement": "site_admin",
"invitation_creation_requirement": "site_admin"
}

List instance modlog events

query Parameters

limit	integer
page	string

Responses

Response samples

200

Content type

application/json

{"items": [{"time": "2019-08-24T14:15:22Z",
"type": "unsuspend_user",
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
},
"community": {"id": 0,
"name": "string",
"local": true,
"host": "string",
"remote_url": "string",
"deleted": true
},
"post": {"id": 0,
"title": "string",
"remote_url": "string",
"sensitive": true
},
"user": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
}
}
],
"next_page": "string"
}

Lookup invitations

query Parameters

key

string

Responses

Response samples

200

Content type

application/json

{"items": [{"id": 0,
"key": "string",
"created_by": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
},
"created_at": "2019-08-24T14:15:22Z",
"used": true
}
],
"next_page": "string"
}

Create an invitation

Responses

Response samples

200

Content type

application/json

{"key": "string",
"id": 0
}

Log in to the service

Request Body schema: application/json

username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"token": "string",
"user": {"id": 0,
"username": "string",
"is_site_admin": true,
"has_unread_notifications": true,
"has_pending_moderation_actions": true
},
"permissions": {"create_community": {"allowed": true
},
"create_invitation": {"allowed": true
}
}
}

Fetch current login state

Authorizations:

bearer

Responses

Response samples

200

Content type

application/json

{"user": {"id": 0,
"username": "string",
"is_site_admin": true,
"has_unread_notifications": true,
"has_pending_moderation_actions": true
},
"permissions": {"create_community": {"allowed": true
},
"create_invitation": {"allowed": true
}
}
}

Log out

Invalidates the current login session.

Authorizations:

bearer

Responses

Upload an image

Uploads an image as hosted media. File content must be sent as the request body.

Authorizations:

bearer

Responses

Response samples

200

Content type

application/json

{"id": "string"
}

Preview Markdown rendering

Request Body schema: application/json

content_markdown

required

string

Responses

Request samples

Payload

Content type

application/json

{"content_markdown": "string"
}

Response samples

200

Content type

application/json

{"content_html": "string"
}

List posts

query Parameters

include_your	boolean
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.
	SortType (string) or string
search	string
in_any_local_community	boolean Filter by whether the post is approved in a local community
use_aggregate_filters	boolean If true, will omit posts from communities marked as hide_posts_from_aggregates
community	integer If present, will filter to posts approved in the specified community
in_your_follows	boolean Filter by whether the post is approved in one of the communities you follow
created_within	string Example: created_within=P6M How far into the past to include posts from, as an ISO8601 duration.
sort_sticky	boolean If true, will sort sticky posts to the top
limit	integer
page	string

Responses

Response samples

200

Content type

application/json

{"items": [{"id": 0,
"title": "string",
"remote_url": "string",
"href": "string",
"content_text": "string",
"content_html": "string",
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"community": {"id": 0,
"name": "string",
"local": true,
"host": "string",
"remote_url": "string"
},
"score": 0,
"sticky": true,
"your_vote": { },
"content_markdown": "string",
"sensitive": true,
"replies_count_total": 0
}
],
"next_page": "string"
}

Create a new post

Authorizations:

bearer

Request Body schema: application/json

community required	integer
href	string URL target for the post. Can be set to a hosted media file by specifying `local-media://<id>`
content_markdown	string
content_text	string
title required	string
	object
sensitive	boolean

Responses

Request samples

Payload

Content type

application/json

{"community": 0,
"href": "string",
"content_markdown": "string",
"content_text": "string",
"title": "string",
"poll": {"multiple": true,
"options": ["string"
],
"closed_in": "PT10M"
},
"sensitive": true
}

Response samples

200

Content type

application/json

{"id": 0
}

Fetch a post

Authorizations:

bearer

path Parameters

postID

required

integer

query Parameters

include_your	boolean
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.

Responses

Response samples

200

Content type

application/json

{"approved": true,
"local": true,
"rejected": true,
"poll": {"multiple": true,
"options": [{"id": 0,
"name": "string",
"votes": 0
}
],
"closed_at": "2019-08-24T14:15:22Z",
"is_closed": true,
"your_vote": {"options": [{"id": 0
}
]
}
},
"id": 0,
"title": "string",
"remote_url": "string",
"href": "string",
"content_text": "string",
"content_html": "string",
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"community": {"id": 0,
"name": "string",
"local": true,
"host": "string",
"remote_url": "string"
},
"score": 0,
"sticky": true,
"your_vote": { },
"content_markdown": "string",
"sensitive": true
}

Delete a post

Authorizations:

bearer

path Parameters

postID

required

integer

Responses

Flag a post

Authorizations:

bearer

path Parameters

postID

required

integer

Request Body schema: application/json

content_text	string
to_community required	boolean
to_site_admin required	boolean
to_remote_site_admin	boolean

Responses

Request samples

Payload

Content type

application/json

{"content_text": "string",
"to_community": true,
"to_site_admin": true,
"to_remote_site_admin": true
}

Response samples

200

Content type

application/json

{ }

Vote in a poll

path Parameters

postID

required

integer

Request Body schema: application/json

One of

options

required

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"option": 0
}

List post replies

path Parameters

postID

required

integer

query Parameters

include_your	boolean
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.
limit	integer
sort	string (SortType) Enum: "hot" "new"
page	string

Responses

Response samples

200

Content type

application/json

{"items": [{"id": 0,
"remote_url": "string",
"content_text": "string",
"content_markdown": "string",
"content_html": "string",
"sensitive": true,
"attachments": [{"url": "string"
}
],
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"deleted": true,
"local": true,
"replies": {"items": [{ }
],
"next_page": "string"
},
"your_vote": { }
}
],
"next_page": "string"
}

Reply to a post

path Parameters

postID

required

integer

Request Body schema: application/json

content_text	string
content_markdown	string
attachment	string Must be a `local-media://` reference
sensitive	boolean

Responses

Request samples

Payload

Content type

application/json

{"content_text": "string",
"content_markdown": "string",
"attachment": "string",
"sensitive": true
}

Response samples

200

Content type

application/json

{"id": 0
}

List likers of a post

path Parameters

postID

required

integer

query Parameters

page

required

string

Responses

Response samples

200

Content type

application/json

{"items": [{"user": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
}
}
],
"next_page": "string"
}

Like a post

Authorizations:

bearer

path Parameters

postID

required

integer

Responses

Retract a like of a post

Authorizations:

bearer

path Parameters

postID

required

integer

Responses

Find a local user by username

query Parameters

local required	boolean Filter by whether the user is local. Currently required to be true.
username required	string Filter by the user's name
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.

Responses

Response samples

200

Content type

application/json

{"items": [{"description": {"content_text": "string",
"content_markdown": "string",
"content_html": "string"
},
"your_note": "string",
"suspended": true,
"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
}
],
"next_page": "string"
}

Register a new account

Request Body schema: application/json

username required	string
password required	string
email_address	string <email>
invitation_key	string
login	boolean If true, will also create a login token for the new user

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"email_address": "user@example.com",
"invitation_key": "string",
"login": true
}

Response samples

200

Content type

application/json

{"user": {"id": 0,
"username": "string",
"is_site_admin": true,
"has_unread_notifications": true,
"has_pending_moderation_actions": true
},
"permissions": {"create_community": {"allowed": true
},
"create_invitation": {"allowed": true
}
},
"token": "string"
}

Fetch information about a user

Authorizations:

bearer

path Parameters

required

string or integer (PathUserID)

query Parameters

include_your	boolean If true, will fetch your_note
image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.

Responses

Response samples

200

Content type

application/json

{"description": {"content_text": "string",
"content_markdown": "string",
"content_html": "string"
},
"your_note": "string",
"suspended": true,
"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
}

List content posted by a user

path Parameters

required

string or integer (PathUserID)

query Parameters

image_handling	string Enum: "remove" "preserve" "convert_to_links" What to do with inline images in HTML content. Defaults to `convert_to_links`.
limit	integer
page	string

Responses

Response samples

200

Content type

application/json

{"items": [{"type": "comment",
"id": 0,
"content_text": "string",
"content_html": "string",
"sensitive": true,
"created": "2019-08-24T14:15:22Z",
"post": {"id": 0,
"title": "string",
"remote_url": "string",
"sensitive": true
}
}
],
"next_page": "string"
}

Edit your personal note for a user

Authorizations:

bearer

path Parameters

required

string or integer (PathUserID)

Request Body schema: application/json

content_text

required

string

Responses

Request samples

Payload

Content type

application/json

{"content_text": "string"
}

Edit your account settings

Authorizations:

bearer

Request Body schema: application/json

description_text	string
description_markdown	string
description_html	string
email_address	string <email>
password	string <password>
avatar	string User profile image. Must be a `local-media://` link

Responses

Request samples

Payload

Content type

application/json

{"description_text": "string",
"description_markdown": "string",
"description_html": "string",
"email_address": "user@example.com",
"password": "pa$$word",
"avatar": "string"
}

Fetch your notifications. Will also clear `has_unread_notifications`.

Authorizations:

bearer

query Parameters

image_handling

string

Enum: "remove" "preserve" "convert_to_links"

What to do with inline images in HTML content. Defaults to convert_to_links.

Responses

Response samples

200

Content type

application/json

{"items": [{"unseen": true,
"type": "post_reply",
"reply": {"id": 0,
"remote_url": "string",
"content_text": "string",
"content_markdown": "string",
"content_html": "string",
"sensitive": true,
"attachments": [{"url": "string"
}
],
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"deleted": true,
"local": true,
"replies": {"items": [{ }
],
"next_page": "string"
},
"your_vote": { }
},
"post": {"id": 0,
"title": "string",
"remote_url": "string",
"href": "string",
"content_text": "string",
"content_html": "string",
"author": {"id": 0,
"username": "string",
"local": true,
"host": "string",
"remote_url": "string",
"is_bot": true,
"avatar": {"url": "string"
}
},
"created": "2019-08-24T14:15:22Z",
"community": {"id": 0,
"name": "string",
"local": true,
"host": "string",
"remote_url": "string"
},
"score": 0,
"sticky": true,
"your_vote": { },
"content_markdown": "string",
"sensitive": true,
"replies_count_total": 0
}
}
],
"next_page": "string"
}

Create a notifications subscription

Request Body schema: application/json

type required	string Value: "web_push"
endpoint required	string
p256dh_key required	string
auth_key required	string

Responses

Request samples

Payload

Content type

application/json

{"type": "web_push",
"endpoint": "string",
"p256dh_key": "string",
"auth_key": "string"
}

Response samples

200

Content type

application/json

{"id": 0
}