List Favorites
users_list_me_favorites( object_id = NULL, object_type = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL )
object_id | integer optional. The id of the object. If specified as a query parameter, must also specify object_type parameter. |
---|---|
object_type | string optional. The type of the object that is favorited. Valid options: Project |
limit | integer optional. Number of results to return. Defaults to 50. Maximum allowed is 1000. |
page_num | integer optional. Page number of the results to return. Defaults to the first page, 1. |
order | string optional. The field on which to order the result set. Defaults to created_at. Must be one of: created_at, object_type, object_id. |
order_dir | string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc. |
An array containing the following fields:
integer, The id of the favorite.
integer, The id of the object. If specified as a query parameter, must also specify object_type parameter.
string, The type of the object that is favorited. Valid options: Project
string, The name of the object that is favorited.
string, The time this favorite was created.