favourites.md 871 Bytes
Newer Older
Eugen Rochko's avatar
Eugen Rochko committed
1
---
2
title: Favourites
Eugen Rochko's avatar
Eugen Rochko committed
3 4
menu:
  docs:
5
    parent: rest-api
Eugen Rochko's avatar
Eugen Rochko committed
6 7
    weight: 10
---
8 9 10

## GET /api/v1/favourites

Eugen Rochko's avatar
Eugen Rochko committed
11 12
Statuses the user has favourited.

13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
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 >}}
Eugen Rochko's avatar
Eugen Rochko committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

## 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" >}})