documentation/content/en/api/rest/favourites.md

44 lines
871 B
Markdown
Raw Normal View History

2018-09-26 00:19:54 +02:00
---
title: Favourites
2018-09-26 00:19:54 +02:00
menu:
docs:
parent: rest-api
2018-09-26 00:19:54 +02:00
weight: 10
---
## GET /api/v1/favourites
2018-10-05 01:37:50 +02:00
Statuses the user has favourited.
Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="read read:favourites" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `limit` | Maximum number of results | Optional | 20 |
### Pagination
{{< api_pagination >}}
2018-10-06 01:09:03 +02:00
## POST /api/v1/statuses/:id/favourite
Favourite a status.
Returns [Status]({{< relref "entities.md#status" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="write write:favourites" version="0.0.0" >}}
## POST /api/v1/statuses/:id/unfavourite
Undo the favourite of a status.
Returns [Status]({{< relref "entities.md#status" >}})