README.md

⚠️ DEPRECATED ⚠️

This command is now part of the Salesforce CLI since v2.56.7:

https://github.com/forcedotcom/cli/tree/main/releasenotes#2567-august-28-2024

---

@cristiand391/sf-plugin-api

A Salesforce CLI plugin to interact with the Salesforce APIs.

Install

sf plugins install @cristiand391/sf-plugin-api

Commands

• sf org api ENDPOINT

sf org api ENDPOINT

Makes an authenticated HTTP request to the Salesforce REST API and prints the response.

USAGE
  $ sf org api ENDPOINT -o <value> [-i] [-X GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE] [-H <value>]
    [--body <value>]

ARGUMENTS
  ENDPOINT  Salesforce API endpoint

FLAGS
  -H, --header=key:value...  HTTP header in "key:value" format.
  -X, --method=<option>      [default: GET] The HTTP method for the request.
                             <options: GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE>
  -i, --include              Include HTTP response status and headers in the output.
  -o, --target-org=username  (required) Username or alias of the target org. Not required if the `target-org`
                             configuration variable is already set.
      --body=file            The file to use as the body for the request (use "-" to read from standard input).

DESCRIPTION
  Makes an authenticated HTTP request to the Salesforce REST API and prints the response.

  You must specify a Salesforce org to use, either with the --target-org flag or by setting your default org with the
  `target-org` configuration variable.

EXAMPLES
  List information about limits in your org:

    $ sf org api 'services/data/v56.0/limits' --target-org my-org

  Get response in XML format by specifying the "Accept" HTTP header:

    $ sf org api 'services/data/v56.0/limits' --target-org my-org --header 'Accept: application/xml'

See code: src/commands/org/api.ts