sf_rest_list: Execute a non-paginated REST API call to list items

In salesforcer: An Implementation of 'Salesforce' APIs Using Tidy Principles

Execute a non-paginated REST API call to list items

Description

Execute a non-paginated REST API call to list items

Usage

sf_rest_list(url, as_tbl = FALSE, records_root = NULL, verbose = FALSE)

Arguments

url	character; a valid REST API URL (as a string)
as_tbl	logical; an indicator of whether to convert the parsed JSON into a tbl_df.
records_root	character or integer; an index or string that identifies the element in the parsed list which contains the records returned by the API call. By default, this argument is NULL, which means that each element in the list is an individual record.
verbose	logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, along with additional diagnostic information where available.

Value

tbl_df or list of data depending on what was requested.

Note

This function is meant to be used internally. Only use when debugging.

salesforcer documentation built on April 12, 2025, 9:12 a.m.