105 lines
2.2 KiB
Markdown
105 lines
2.2 KiB
Markdown
|
---
|
||
|
|
title: Relationship
|
||
|
|
description: >-
|
||
|
|
Represents the relationship between accounts, such as following / blocking /
|
||
|
|
muting / etc.
|
||
|
|
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
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Required attributes <a id="relationship"></a>
|
||
|
|
|
||
|
|
### `id`
|
||
|
|
|
||
|
|
**Description:** The account id.
|
||
|
|
**Type:** String \(cast from an integer, but not guaranteed to be a number\)
|
||
|
|
**Version history:** Added in 0.6.0
|
||
|
|
|
||
|
|
### `following`
|
||
|
|
|
||
|
|
**Description:** Are you following this user?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 0.6.0
|
||
|
|
|
||
|
|
### `requested`
|
||
|
|
|
||
|
|
**Description:** Do you have a pending follow request for this user?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 0.9.9
|
||
|
|
|
||
|
|
### `endorsed`
|
||
|
|
|
||
|
|
**Description:** Are you featuring this user on your profile?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 2.5.0
|
||
|
|
|
||
|
|
### `followed_by`
|
||
|
|
|
||
|
|
**Description:** Are you followed by this user?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 0.6.0
|
||
|
|
|
||
|
|
### `muting`
|
||
|
|
|
||
|
|
**Description:** Are you muting this user?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 1.1.0
|
||
|
|
|
||
|
|
### `muting_notifications`
|
||
|
|
|
||
|
|
**Description:** Are you muting notifications from this user?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 2.1.0
|
||
|
|
|
||
|
|
### `showing_reblogs`
|
||
|
|
|
||
|
|
**Description:** Are you receiving this user's boosts in your home timeline?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 2.1.0
|
||
|
|
|
||
|
|
### `blocking`
|
||
|
|
|
||
|
|
**Description:** Are you blocking this user?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 0.6.0
|
||
|
|
|
||
|
|
### `domain_blocking`
|
||
|
|
|
||
|
|
**Description:** Are you blocking this user's domain?
|
||
|
|
**Type:** Boolean
|
||
|
|
**Version history:** Added in 1.4.0
|
||
|
|
|
||
|
|
### `blocked_by`
|
||
|
|
|
||
|
|
**Description:** Is this user blocking you?
|
||
|
|
**Type:** Boolean
|
||
|
|
**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" >}}
|
||
|
|
|
||
|
|
|
||
|
|
|