Skip to content

API Conventions

The Kodexa supports a rich RESTful API that allows you to interact every aspect of the platform. This document describes the conventions used:

  • Curly braces ({}) in API routes represent path parameters, for example, GET /api/stores/{orgSlug}/{storeSlug}
  • Required fields are marked by an asterisk (*)
  • Placeholder text is in uppercase characters with underscore delimiters, for example, MASTER_KEY


The Kodexa API supports three forms of authentication:

  • Basic Authentication - This is the simplest form of authentication.
  • API Key - This is a unique key that is used to authenticate, the header is X-ACCESS-TOKEN and will need to contain a personal access token.
  • JWT - This is a JSON Web Token that is used to authenticate