Print this page
The reference documentation includes comprehensive information about the schema, including the queries, mutations, objects, fields, arguments, and other elements of the schema.
You can refer to the reference documentation to perform the following tasks:
●Determine the data that you can retrieve using the Ringtail Connect API.
●View a list of the queries and mutations that are available, and the valid structure for each operation.
●View a description of elements in the schema.
Because the reference documentation is generated automatically from the schema, the information that it contains reflects the current state of the schema. However, you may also need to validate API calls in the API explorer.
Use the following procedure to access the API reference documentation.
1.To access the API explorer, on the Portal Home page, under Portal Management, click Ringtail Connect API Explorer.
A list of the root queries and mutations appears.
3.To browse through the reference documentation, click through the queries, mutations, objects, and fields. Or, search for an element. To return to the previous element, click the left arrow on the reference documentation toolbar.
Note: In the reference documentation, an exclamation mark (!) indicates that a field is required in an argument.