cto_dataset_list: List Available Server Datasets

View source: R/cto_dataset_list.R

cto_dataset_listR Documentation

List Available Server Datasets

Description

Retrieves a list of datasets that the authenticated user has access to. Results can be filtered by team and ordered by specified fields.

Usage

cto_dataset_list(
  order_by = "createdOn",
  sort = c("ASC", "DESC"),
  team_id = NULL
)

Arguments

order_by

String. The field to sort the results by. Options are: "id", "title", "createdOn", "modifiedOn", "status", "version", or "discriminator". Defaults to "createdOn".

sort

String. The direction of the sort: "asc" (ascending) or "desc" (descending). Defaults to "asc".

team_id

String (Optional). Filter datasets by a specific Team ID. If provided, only datasets accessible to that team are returned. Example: 'team-456'.

Value

A data frame containing the metadata of available datasets.

See Also

Other Dataset Management Functions: cto_dataset_create(), cto_dataset_delete(), cto_dataset_download(), cto_dataset_info()

Examples

## Not run: 
# List all datasets sorted by creation date
ds_list <- cto_dataset_list()

# List datasets for a specific team, ordered by title
team_ds <- cto_dataset_list(team_id = "team-123", order_by = "title")

## End(Not run)

ctoclient documentation built on March 28, 2026, 5:07 p.m.