sf_describe_object_fields: Describe Object Fields

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

Describe Object Fields

Description

This function takes the name of an object in Salesforce and returns a description of the fields on that object by returning a tibble with one row per field.

Usage

sf_describe_object_fields(object_name)

Arguments

object_name

character; the name of the Salesforce object that the function is operating against (e.g. "Account", "Contact", "CustomObject__c").

Value

A tbl_df containing one row per field for the requested object.

Note

The tibble only contains the fields that the user can view, as defined by the user's field-level security settings.

Examples

## Not run: 
acct_fields <- sf_describe_object_fields('Account')

## End(Not run)

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