User Interface API Developer Guide
jNewer Version Available
User Interface API Quick Start
If you don’t already have an org, you can sign up for a Salesforce Developer Edition, also known as a DE org.
This quick start makes a request to the List UI resource, /ui-api/list-ui/${objectApiName}. This resource returns a collection of list views for an object.
Before you connect Postman to Salesforce, fork and configure the collection.
These steps use the Postman desktop app to send a request. Alternatively, you can connect the Postman web app to Salesforce using the Trailhead quick start, which requires a CORS configuration in Salesforce.
- Open the Postman desktop app.
- Expand the collection, and select the .
- Select .
- Click Send.
The query returns a 200 OK status. If you receive an error, check your configuration and try again.
The List View Summary Collection response body includes an array of list views.
You just sent a UI API request using Postman! You can do more with UI API using Postman, such as sending a cURL command to upload a file to your Salesforce org.
To send a cURL command, import the request using raw text.
- In Postman, click the Import tab on the top left side.
- Select the Raw text tab.
- Paste your cURL command and click Continue.
- Verify your request name and format, then click Import.
- Send your request.
Consider the following guidelines.
- If you’re sending any JSON data as part of your cURL command, the import adds the JSON string as a key on the tab by default. Move the JSON string from the tab to the tab, and delete it from the tab.
- If you’re sending a file using the -F option, upload your file under the tab. For example, you can upload files by adding the fileData key and selecting a local file.
