Schemas

Follow relationship between two accounts: whether the first follows the second, and whether it is followed back.

Endpoints

1 endpoint returns relationships on X.

Schema

Every endpoint above returns this object as data. The standard meta comes with every response.

platformstring

Platform ID (x, …).

sourceobject

The account whose follow is checked (the handle param): is_following says whether it follows target. At least its id or username.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

targetobject

The other account (the target param): is_followed_by says whether it follows source. At least its id or username.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

is_followingbooleannullable

True when source follows target, false when it does not; null when the platform did not say.

is_followed_bybooleannullable

True when target follows source, false when it does not; null when the platform did not say. Both true: they follow each other.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
xobjectnullable

An X relationship's own fields: whether source can send target a direct message.

ShowHide 1 child field
is_messageablebooleannullable

True when X would let source send target a direct message (target follows source, or accepts messages from anyone), false when it would not; null when X did not say.

Item errors

Besides the request-level errors every endpoint can return, relationship endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).Check the link or ID. Do not retry.
private_or_unavailable403NoThe item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.Only public items can be fetched. Do not retry.

Last updated