R/api-teams.R

In psolymos/clickrup: Interacting with the ClickUp v2 API from R

#' Teams (workspaces)
#'
#' Working with teams (workspaces) in ClickUp tasks (<https://clickup.com/api>).
#' Teams is the legacy term for what are now called workspaces in ClickUp.
#' For compatablitly, the term team is still used in the API v2.
#' This is NOT the new 'Teams' feature which represents a group of users.

#' @param cu_token ClickUp personal access token or an access token from the OAuth flow.
#'   The `CU_PAT` environment variable is used when `NULL`.
#' @examples
#' \dontrun{
#' cu_get_teams()
#' }
#'
#' @return
#'
#' A cu object.
#'
#' @seealso [cu-class] for the cu object class.
#'
#' @export
#' @name api-teams
## Teams / Get Teams
## GET https://api.clickup.com/api/v2/team
##
## Teams is the legacy term for what are now called Workspaces in ClickUp.
## For compatablitly, the term team is still used in this API.
## This is NOT the new "Teams" feature which represents a group of users.
cu_get_teams <- function(cu_token = NULL) {
    .cu_get("team", cu_token = cu_token)
}
#cu_get_workspaces <- cu_get_teams