Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.

API Documentation

FavoriteUser

Overview

Represents the association between a user and another user they've marked as favorite.

Fields

Field Visibility Level Permission Scope Type Description
user_id public/private favorites_rw int The user's numeric ID. Note: This field may be absent, depending on the user's privacy settings.
favorite_user_id public none int The numberic ID of this favorite user association.
Deprecated: do not use.
target_user_id public none int The targeted favorite user's numeric ID.
creation_tsz public none float The date and time that the user was favorited.

Associations

Association Visibility Level Permission Scope Type Description
User public/private favorites_rw User The user who marked the target user as a favorite. Note: This field may be absent, depending on the user's privacy settings.
TargetUser public none User The user who was marked as a favorite.

Methods

findAllUserFavoredBy

Method Name findAllUserFavoredBy
Synopsis Retrieves a set of FavoriteUser objects associated to a User.
HTTP Method GET
URI /users/:user_id/favored-by
Parameters
Name Required Default Type
user_id Y   user_id_or_name
limit N 25 int
offset N 0 int
page N   int
Requires OAuth N
Permission Scope none

findAllUserFavoriteUsers

Method Name findAllUserFavoriteUsers
Synopsis Finds all favorite users for a user
HTTP Method GET
URI /users/:user_id/favorites/users
Parameters
Name Required Default Type
user_id Y   user_id_or_name
limit N 25 int
offset N 0 int
page N   int
Requires OAuth N
Permission Scope none

findUserFavoriteUsers

Method Name findUserFavoriteUsers
Synopsis Finds a favorite user for a user
HTTP Method GET
URI /users/:user_id/favorites/users/:target_user_id
Parameters
Name Required Default Type
user_id Y   user_id_or_name
target_user_id Y   user_id_or_name
Requires OAuth N
Permission Scope none

createUserFavoriteUsers

Method Name createUserFavoriteUsers
Synopsis Creates a new favorite listing for a user
HTTP Method POST
URI /users/:user_id/favorites/users/:target_user_id
Parameters
Name Required Default Type
user_id Y   user_id_or_name
target_user_id Y   user_id_or_name
Requires OAuth Y
Permission Scope favorites_rw

deleteUserFavoriteUsers

Method Name deleteUserFavoriteUsers
Synopsis Delete a favorite listing for a user
HTTP Method DELETE
URI /users/:user_id/favorites/users/:target_user_id
Parameters
Name Required Default Type
user_id Y   user_id_or_name
target_user_id Y   user_id_or_name
Requires OAuth Y
Permission Scope favorites_rw

Open API v3New

Your developer account