Skip to content
Kordon Learn

API Overview

You can use Kordon’s API to build scripts and applications that automate processes, integrate with Kordon, and extend Kordon. For example, you could use the API to sync assets with your asset management system.

Each REST API endpoint is documented individually, and the endpoints are categorized by the resource that they primarily affect.

Every request to the REST API includes an HTTP method and a path. Depending on the REST API endpoint, you might also need to specify request headers, authentication information, query parameters, or body parameters.

Where possible, the Kordon REST API strives to use an appropriate HTTP method for each action.

  • GET Used for retrieving resources.
  • POST Used for creating resources.
  • PATCH Used for updating properties of resources.
  • DELETE Used for deleting resources.

Base URL

Section titled “Base URL”

All API requests should be made to:

https://YOUR_KORDON_URL/api/v1/

Description Fields

Section titled “Description Fields”

Many objects in the Kordon API include a description field that accepts basic HTML. Kordon uses the Lexical WYSIWYG editor for rich text content. When creating or updating resources with descriptions, you can include HTML formatting such as:

  • Paragraphs: <p>Your text here</p>
  • Bold: <strong>Bold text</strong> or <b>Bold text</b>
  • Lists: <ul><li>Item</li></ul> or <ol><li>Item</li></ol>
  • Links: <a href="url">Link text</a>

Example:

{
  "description": "<p>This is a <strong>formatted</strong> description.</p>"
}

API Resources

Section titled “API Resources”