cu-pat: Managing ClickUp personal access token

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

Managing ClickUp personal access token

Description

The ClickUp API requires a personal access token (PAT) to be sent with each API request. The cu_set_pat function uses Sys.setenv to set the CU_PAT environment variable for other processes called from within R or future calls to Sys.getenv from the same R process. cu_get_pat is used to retrieve the PAT for the API calls.

Usage

cu_get_pat(token = NULL)

cu_set_pat(token)

Arguments

token

ClickUp personal access token or an access token from the OAuth flow. The CU_PAT environment variable is used when NULL.

Details

To set up a ClickUp PAT, Follow this tutorial:

• sign up for ClickUp (you can use this referral link to do so, it's free),

• navigate to your personal Settings,

• click Apps in the left sidebar,

• click Generate to create your API token,

• click Copy to copy the token to your clipboard.

Now add your ClickUp token as an environment variable:

• open the file .Renviron: file.edit("~/.Renviron"),

• add a line with CU_PAT="your_token" to the .Renviron file and save it,

• check with Sys.getenv("CU_PAT"), it should return the token.

Value

cu_set_pat returns logical similarly to Sys.setenv().

cu_get_pat returns the ClickUp PAT that will look something like pk_4753994_EXP7MPOJ7XQM5UJDV2M45MPF0YHH5YHO. When token is not NULL it will simply pass through the token value and not look for the CU_PAT environment variable.

See Also

Sys.setenv() and Sys.getenv()

psolymos/clickrup documentation built on Feb. 9, 2024, 10:09 a.m.