Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get an App

Get the metadata for an app.

Resource

1/ui-api/apps/${appId}

Available Version

43.0

HTTP Method

GET

Example

As an example, let’s say that the user has an app with an ID of 06mRM000000AFIrYAO. To get metadata for this app, make this request:

1GET /services/data/v67.0/ui-api/apps/06mRM000000AFIrYAO?formFactor=Large

The request returns metadata for the app and its associated navigation tabs.

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`formFactor`	String	The form factor for each app that the user has access to. `Large`—App supports the desktop display size. `Medium`—App supports the tablet display size. `Small`—App supports the phone display size.	Required	43.0
`userCustomizations`	Boolean	If `true`, gets custom and standard navigation tabs. If false, gets only standard navigation tabs.	Optional	43.0

Response Body

App

User Interface API Developer Guide

Get an App