Available APIs
  • 19 Mar 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Available APIs

  • Dark
    Light
  • PDF

Article Summary

About this Article
This article provides information related to the available CMS APIs


[Version 3.0.0 and Above]

CMS provides several APIs to assist the user to achieve various actions. This includes information related to endpoints, request format, response format and a mapping of error codes to their meaning.

  1. Navigate to Help > API Documentation in the left navigation pane
  2. All the available APIs are listed under relevant categories. Expand the required category to view information related to a specific API
  3. For each API, the base URL, required parameters are listed
  4. Click Try it out and provide the required values for the parameters. The bearer token of the user is the oAuth Token that can be obtained from Access Management. Click here for more information 
  5. Click Execute. The response JSON is provided on the screen. This response can be downloaded
  6. Alternatively, the provided curl command can be used to access API
  7. A sample API is provided belowSampleAPI
  8. A sample curl command is provided belowSampleCurlCommand

Was this article helpful?