- 06 Sep 2024
- 1 minute to read
View API documentation
- Updated on 06 Sep 2024
- 1 minute to read
When working with the external API in Totara, you may want to see an API reference guide, which describes all of the services available in the API and how to use them. Totara has built-in reference documentation generated from the GraphQL schema. This documentation will reflect the API features available for the specific version of Totara the site is running, and will include services added or modified by third-party code customisations.
While we recommend reviewing the API documentation on your Totara site for the most accurate and up-to-date information, if you do not have access to a Totara site you can see the generic reference documentation in our developer documentation.
To view the documentation, follow these steps:
- Navigate to Quick-access menu > Development > API > API documentation.
- Use the table of contents in the left-hand column to jump to a specific section.
- Click Back to API to return to the list of API clients.
On this page you can see the following information about the API:
- Endpoint details
- Authentication
- Request format
- Link to the API schema
- Available queries and mutations
- Available types
The documentation page includes examples of the format of both the specific request and the response that will be returned from the API.
© Copyright 2024 Totara Learning Solutions. All rights reserved.