polished (version 0.4.0)

get_apps: Polished API - Get App(s)

Description

Polished API - Get App(s)

Usage

get_apps(
  app_uid = NULL,
  app_name = NULL,
  api_key = getOption("polished")$api_key
)

Arguments

app_uid

an optional app uid.

app_name

an optional app name.

api_key

your Polished API key. Set your polished api key using set_api_key() so that you do not need to supply this argument with each function call.

Value

an object of class polished_api_res. The "content" of the object is a tibble of app(s) with the following columns:

• uid

• app_name

• app_url

• created_at

• modified_at

Details

If both the app_uid and app_name are NULL, then all the apps in your account will be returned. If either app_uid or app_name are not NULL, then a single app will be returned (assuming the app exists). If both the app_uid and app_name are provided, then the app_uid will be used, and the app_name will be ignored. If the app does not exists, a zero row tibble will be returned.

See Also

add_app() update_app() delete_app()