Relationship

Represents the relationship between accounts, such as following / blocking / muting / etc.

Example

{
  "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

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

mastodon/app/serializers/rest/relationship_serializer.rb at main · mastodon/mastodonGitHub

app/serializers/rest/relationship_serializer.rb