Example: Retrieve data with the Salesforce API

This topic provides an example on how you retrieve data with the Salesforce API.

Prerequisites

Procedure

It is described in the documentation how to add an operation with the API Designer.
  1. In the Cockpit, go to the API Designer and open the API connected to Salesforce.

  2. Navigate to the Operations tab and click Add.

  3. In Path, add the following: /services/data/v43.0/query/?q=SELECT (columns) FROM Account

  4. Add GET as method.

  5. Give a summary on what the API does, for example, "Retrieves columns from the account table".

  6. Navigate to the Request tab.

  7. Add a Parameter and enter a Name, for example, columns.

  8. Check In Path and Required.

  9. Click Save.

    You can test your API with the API Client.

Results

  • You have retrieved data via the Salesforce API.