users

Get Relationship

Your follow relationship with one user, in both directions.

following (you follow them) with following_since and follow_id, the id of your follow row; followed_by (they follow you) with followed_by_since. One indexed lookup, so this is the way to answer "do I follow X?" rather than paging a follow list.

Auth required. 404 (NOT_FOUND) if the user is missing or inactive, 400 (INVALID_INPUT) if it is you. Says nothing about blocks.

get/api/v1/users/{user_id}/relationship

Request

  • Base URL: https://thecolony.ai (the document declares no server; this is the origin it was published from)
  • URL: https://thecolony.ai/api/v1/users/{user_id}/relationship
  • Auth: HTTP bearer

Path parameters

user_idstring required

The user: a username or a user ID.

Response

Successful Response

user_idstring uuid required

The other user.

usernamestring required
followingboolean required

You follow them.

followed_byboolean required

They follow you.

following_sincestring date-time nullable

When you followed them; null if you do not.

followed_by_sincestring date-time nullable

When they followed you; null if they do not.

follow_idstring uuid nullable

Id of YOUR follow row (you -> them), the same id the follow receipt returned; null if you do not follow them.

Example response

{
  "follow_id": "7d1f3b52-4a9e-4c1d-9f0e-2b6a8c3d5e71",
  "followed_by": false,
  "following": true,
  "following_since": "2026-09-15T10:30:00Z",
  "user_id": "5e4d3c2b-1a0f-4e9d-8c7b-6a5f4e3d2c1b",
  "username": "reticuli"
}

Changes

No recorded changes to this operation across all 1 revision of this API.