2020-01-01 22:37:59 +01:00
|
|
|
---
|
|
|
|
title: Relationship
|
2020-01-12 14:11:56 +01:00
|
|
|
description: Represents the relationship between accounts, such as following / blocking / muting / etc.
|
2020-01-01 22:37:59 +01:00
|
|
|
menu:
|
|
|
|
docs:
|
|
|
|
parent: entities
|
|
|
|
---
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
{
|
|
|
|
"id": "1",
|
|
|
|
"following": true,
|
|
|
|
"showing_reblogs": true,
|
|
|
|
"followed_by": true,
|
|
|
|
"blocking": false,
|
|
|
|
"blocked_by": false,
|
|
|
|
"muting": false,
|
|
|
|
"muting_notifications": false,
|
|
|
|
"requested": false,
|
|
|
|
"domain_blocking": false,
|
|
|
|
"endorsed": false
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
## Required attributes {#relationship}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `id` {#id}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** The account id.\
|
|
|
|
**Type:** String \(cast from an integer, but not guaranteed to be a number\)\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 0.6.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `following` {#following}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you following this user?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 0.6.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `requested` {#requested}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Do you have a pending follow request for this user?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 0.9.9
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `endorsed` {#endorsed}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you featuring this user on your profile?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 2.5.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `followed_by` {#followed_by}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you followed by this user?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 0.6.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `muting` {#muting}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you muting this user?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 1.1.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `muting_notifications` {#muting_notifications}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you muting notifications from this user?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 2.1.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `showing_reblogs` {#showing_reblogs}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you receiving this user's boosts in your home timeline?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 2.1.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `blocking` {#blocking}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you blocking this user?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 0.6.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `domain_blocking` {#domain_blocking}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Are you blocking this user's domain?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 1.4.0
|
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
### `blocked_by` {#blocked_by}
|
2020-01-01 22:37:59 +01:00
|
|
|
|
2020-01-12 14:11:56 +01:00
|
|
|
**Description:** Is this user blocking you?\
|
|
|
|
**Type:** Boolean\
|
2020-01-01 22:37:59 +01:00
|
|
|
**Version history:** Added in 2.8.0
|
|
|
|
|
|
|
|
## See also
|
|
|
|
|
|
|
|
* [GET /api/v1/accounts/relationships](../methods/accounts/#check-relationships-to-other-accounts)
|
|
|
|
|
|
|
|
{{< caption-link url="https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/relationship_serializer.rb" caption="app/serializers/rest/relationship\_serializer.rb" >}}
|
|
|
|
|
|
|
|
|
|
|
|
|