Skip to main content

API Command Lookup

Distributor or developer steps for looking up an API Command's details, parameters and an example URL on the API Commands Look Up tab in Encompass. Requires v22.06+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 22.06

Steps

How to Use API Command Lookup

1. Using the universal search, navigate to the API Commands dashboard.
​
2. Select "API Commands Look Up" from the provided tabs.
​
3. Select an Application and API Command then click Search.
​
4. The result shows all available information about the selected API command. Under the API Parameters, click on the available options to show more information.
​
5. An example URL to be used is also provided at the bottom of this dashboard.

Did this answer your question?