What is the external API?
  • 05 Jul 2023
  • 1 minute to read

What is the external API?

Article summary

This documentation is for the external API only. For more information about other Totara APIs please refer to the developer documentation.

The external API allows you to connect external systems to your Totara site. Previously, you could do this using web services, but the external API replaces web services as Totara's primary API where future services will be created.

The API features the following:

  • Industry-standard OAuth 2.0 authentication
  • GraphQL-based requests, allowing for tailored queries for the precise data you need
  • Automatically generated reference documentation and client auto-complete via introspection
  • Extensibility, allowing additional services to be added and existing services to be extended in third-party code

Once you have enabled the API, you can manage the clients available on your site.

© Copyright 2024 Totara Learning Solutions. All rights reserved.

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.