API Search List Screen

Updated on 15 May 2025
1 Minute to read

Article summary

Did you find this summary helpful?

Thank you for your feedback

As a system administrator, you'll use the API Search List screen to create and manage API credentials needed for third-party integrations in Aspire. From this screen, you can gather key values like the Client ID, Secret, and Scope, which are used in the authentication process. For more information about using APIs with Aspire, review how an API will improve Aspire user experience.

Screen Element	Description
New^a	Create a new set of API credentials.
Remove^b	Delete existing API credentials.

Create New API Credentials

Screen Element	Description
Save^a	Retain any changes you have made. If you try to navigate away from the screen without saving your changes, a confirmation dialog box will populate.
Description^b	Assign a description to your API credentials that will help you recall the integration that you use the credentials for.
Client ID^c	Input your Client ID or Token from the platform you are integrating with Aspire.
Secret^d	Generate a Secret Key.
Scope	Define the access level and endpoints that the API credentials can interact with. Use the checkboxes to select specific HTTP methods (`GET`, `POST`, `PUT`, `DELETE`) or to grant full access across all available endpoints. You can also enable access for Takeoff Integration, if applicable. The Scope table is organized by controller. Expand each controller to view and manage access to its individual endpoints. Select only the permissions necessary for your integration to follow best practices in API security and minimize potential risk. Note: Changes to Scope do not take effect until you save the credential set.

Was this article helpful?

What's Next

Branches Search List Screen

Table of contents

Create New API Credentials