Use the Connect API Explorer

The following high-level steps describe how to work with the Connect API Explorer.

Your system administrator grants you access to the Connect API Explorer page. For more information, see Manage security for the Connect API Explorer.

Access the API using the interactive Connect API Explorer in the application.

Note: The Connect API Explorer allows you to explore the schema, run queries and mutations, and view responses. For more information, see Access and use the Connect API Explorer.

Perform operations to request or modify data in the application.

For information about how to create a query, see Request data: queries.

For information about how to modify data using a mutation, see Modify data: mutations.

For examples of queries or mutations that you can use as a starting point, see Data retrieval query examples or Import mutation examples.

Optionally, do any of the following:

Interact with the Connect API Explorer using HTTP GET and POST requests. For more information, see Use HTTP GET and POST requests to interact with the Connect API.

Populate the application data in a Microsoft Excel spreadsheet, and then programmatically refresh the data. For more information, see Integrate Microsoft Excel with the Connect API.

Interact with the API using PowerShell. For information about example queries that you can use as a starting point to create your own queries in PowerShell, see Query the Connect API from PowerShell.

Tip: The application SDK includes a toolkit with sample code and explanations of additional ways that you can interact with the Connect API using third-party applications. To get access to the UI Extension SDK, contact Discover.Sales@Nuix.com.