users_list_me_favorites: List Favorites

In civis: R Client for the 'Civis Platform API'

List Favorites

Description

List Favorites

Usage

users_list_me_favorites(
  object_id = NULL,
  object_type = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

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: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report
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 position. Must be one of: position, created_at.
order_dir	string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.

Value

An array containing the following fields:

id	integer, The id of the favorite.
objectId	integer, The id of the object. If specified as a query parameter, must also specify object_type parameter.
objectType	string, The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report
objectName	string, The name of the object that is favorited.
createdAt	string, The time this favorite was created.
objectUpdatedAt	string, The time the object that is favorited was last updated
objectAuthor	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.
position	integer, The rank position of this favorite. Use the patch users/me/favorites/:id/ranking/ endpoints to update.

civis documentation built on Aug. 30, 2025, 1:08 a.m.