Print this page
The following high-level steps describe how to work with the Ringtail Connect API.
1.Your system administrator grants you access to the Ringtail Connect API. For more information, see Manage security for the Ringtail Connect API.
2.Access the API using the interactive API explorer in Ringtail. The API explorer allows you to explore the schema, run queries and mutations, and view responses. For more information, see Access and use the Ringtail Connect API Explorer.
3.Perform operations to request or modify data in Ringtail.
oFor information about how to create a query, see Request data: queries.
oFor information about how to modify data using a mutation, see Modify data: mutations.
oFor information about example queries that you can use as a starting point to create your own reports, see Reporting examples.
4.Optionally, do any of the following:
oInteract with the API using HTTP GET and POST requests. For more information, see Use HTTP GET and POST requests to interact with the Ringtail Connect API.
oPopulate Ringtail data in a Microsoft Excel spreadsheet, and then programmatically refresh the data. For more information, see Integrate Microsoft Excel with the Ringtail Connect API.
oInteract 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 Ringtail Connect API from PowerShell.
Tip: The Ringtail SDK includes a toolkit with sample code and explanations of additional ways that you can interact with the Ringtail Connect API using third-party applications. To get access to the UI Extension SDK, contact info@ringtail.com.
