documentation/content/en/entities/list.md

52 lines
1.1 KiB
Markdown
Raw Normal View History

---
title: List
description: Represents a list of some users that the authenticated user follows.
menu:
docs:
parent: entities
---
## Example
```javascript
{
"id": "12249",
"title": "Friends"
}
```
## Required attributes
### `id` {#id}
**Description:** The internal database ID of the list.\
**Type:** String \(cast from an integer, but not guaranteed to be a number\)\
**Version history:**\
2.1.0 - added
### `title` {#title}
**Description:** The user-defined title of the list.\
**Type:** String\
**Version history:**\
2.1.0 - added
### `replies_policy` {#replies_policy}
**Description:** The user-defined title of the list.\
**Type:** String (Enumerable oneOf)\
`followed` = Show replies to any followed user\
`list` = Show replies to members of the list\
`none` = Show replies to no one\
**Version history:**\
3.3.0 - added
## See also
{{< page-ref page="methods/timelines/lists.md" >}}
{{< caption-link url="https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/list_serializer.rb" caption="app/serializers/rest/list\_serializer.rb" >}}