Caller's social-graph relationship with this user

GET

/users/{ref}/relationship

• Local development behind nginx (port 8088 by default)

The single round-trip the profile page consumes to decide which “Follow/Unfollow/Blocked/Block” button to render. Reports both directions of follow + the bidirectional block bit. Anonymous callers receive an all-false response (still 200) since the relationship is anchored on the caller; client code can short-circuit rendering on is_self.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

ref

required

integer format: int64

Responses

200

Relationship snapshot.

Caller’s relationship with the target user. Profile pages consume this in one round-trip to decide which Follow/Unfollow/Block/Unblock button(s) to render. is_self short-circuits all the other flags.

object

is_self

required

True when the caller IS the target — UI hides social buttons.

boolean

is_following

required

Caller follows target.

boolean

is_followed_by

required

Target follows caller.

boolean

is_blocked_by_me

required

Caller has blocked target. Implies social hide on both sides.

boolean

is_blocked_by_them

required

Target has blocked caller. Implies social hide on both sides.

boolean

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

404

Resource not found

object

error

required

Human-readable error summary

string

Example

the request could not be completed