qbr (version 1.3.0)

get_fields: Get all fields in a table

Description

Get metadata for all fields in a table.

Usage

get_fields(
  subdomain,
  auth,
  table_id,
  agent = NULL,
  include_props = T,
  include_perms = F
)

Value

A tibble.

Arguments

subdomain

Character vector with one element. Found at the beginning of the Quickbase URL. Realm specific.

auth

Character vector with one element. The Quickbase authentication scheme you are using to authenticate the request (e.g., user token).

table_id

Character vector with one element. Found in the URL of a Quickbase table.

agent

Optional. Character vector with one element. Describes user/agent making API call.

include_props

Logical. Includes field properties if true.

include_perms

Logical. Includes custom field permissions if true. Only returns data if custom permissions exist for at least 1 field in the table.

Examples

if (FALSE) {
   get_fields(subdomain = "abc",
              auth = keyring::key_get("qb_example"),
              table_id = "bsf5hphe5")
}