zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Update API.md

This commit is contained in:
Eugen Rochko 2017-12-13 15:43:16 +01:00 committed by GitHub
parent 6b3455ecf6
commit 4b8f6e1726
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Using-the-API/API.md
View File

@ -82,7 +82,13 @@ Returns an [Account](#account).
GET /api/v1/accounts/verify_credentials
Returns the authenticated user's [Account](#account).
Returns the authenticated user's [Account](#account) with an extra attribute `source` which contains these keys:
| Attribute | Description |
| ----------- | -------------------------------------------------------- |
| `privacy` | Selected preference: Default privacy of new toots |
| `sensitive` | Selected preference: Mark media as sensitive by default? |
| `note` | Plain-text version of the account's `note` |
#### Updating the current user:
@ -601,19 +607,19 @@ Public and tag timelines do not require authentication.
GET /api/v1/lists
Returns at most 50 results without pagination.
Returns at most 50 [Lists](#list) without pagination.
#### Retrieving lists by membership
GET /api/v1/accounts/:id/lists
Returns at most 50 results without pagination.
Returns at most 50 [Accounts](#account) without pagination.
#### Retrieving accounts in a list
GET /api/v1/lists/:id/accounts
Returns accounts in the list. If you specify `limit=0` in the query, all accounts will be returned without pagination. Otherwise, standard account pagination rules apply.
Returns [Accounts](#account) in the list. If you specify `limit=0` in the query, all accounts will be returned without pagination. Otherwise, standard account pagination rules apply.
#### Retrieving, creating, updating, deleting a list
@ -725,6 +731,8 @@ ___
### Error
The most important part of an error response is the HTTP status code. Standard semantics are followed. The body of an error is a JSON object with this structure:
| Attribute | Description | Nullable |
| ------------------------ | ---------------------------------- | -------- |
| `error` | A textual description of the error | no |