differences_in_mastoapi_responses.md 3.99 KB
Newer Older
1
2
# Differences in Mastodon API responses from vanilla Mastodon

Maksim's avatar
Maksim committed
3
A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
4

5
6
7
8
9
10
## Flake IDs

Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However just like Mastodon's ids they are sortable strings

## Attachment cap

11
Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
lain's avatar
lain committed
12
13
14
15

## Timelines

Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
16
17
18

## Statuses

19
Has these additional fields under the `pleroma` object:
20
21

- `local`: true if the post was made on the local instance.
22
- `conversation_id`: the ID of the conversation the status is associated with (if any)
23
- `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
24
25
- `content`: a map consisting of alternate representations of the `content` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
- `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
26

27
28
29
30
31
32
## Attachments

Has these additional fields under the `pleroma` object:

- `mime_type`: mime type of the attachment.

33
34
35
## Accounts

- `/api/v1/accounts/:id`: The `id` parameter can also be the `nickname` of the user. This only works in this endpoint, not the deeper nested ones for following etc.
36

37
38
39
40
Has these additional fields under the `pleroma` object:

- `tags`: Lists an array of tags for the user
- `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/api/entities/#relationship
41
42
- `is_moderator`: boolean, nullable,  true if user is a moderator
- `is_admin`: boolean, nullable, true if user is an admin
43
- `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
44
45
- `hide_followers`: boolean, true when the user has follower hiding enabled
- `hide_follows`: boolean, true when the user has follow hiding enabled
rinpatch's avatar
rinpatch committed
46
47
48
49
50
51
52

### Source

Has these additional fields under the `pleroma` object:

- `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
- `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
53

54
55
56
57
58
59
## Account Search

Behavior has changed:

- `/api/v1/accounts/search`: Does not require authentication

60
61
62
63
64
## Notifications

Has these additional fields under the `pleroma` object:

- `is_seen`: true if the notification was read by the user
rinpatch's avatar
rinpatch committed
65
66
67

## POST `/api/v1/statuses`

68
Additional parameters can be added to the JSON body/Form data:
rinpatch's avatar
rinpatch committed
69

70
- `preview`: boolean, if set to `true` the post won't be actually posted, but the status entitiy would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.
71
- `content_type`: string, contain the MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint.
72
73
74
75
76
77
78
79
80
81

## PATCH `/api/v1/update_credentials`

Additional parameters can be added to the JSON body/Form data:

- `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
- `hide_followers` - if true, user's followers will be hidden
- `hide_follows` - if true, user's follows will be hidden
- `hide_favorites` - if true, user's favorites timeline will be hidden
- `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
82
- `default_scope` - the scope returned under `privacy` key in Source subentity
Maksim's avatar
Maksim committed
83
84
85
86
87
88
89

## Authentication

*Pleroma supports refreshing tokens.

`POST /oauth/token`
Post here request with grant_type=refresh_token to obtain new access token. Returns an access token.