The official JSON:API Specification website offers plenty of helpful information if you are a first time JSON:API user. Regardless of your familiarity with JSON:API here are some core conventions to be aware of as you explore our Platform:
- The root object for a resource is always “data”.
- The resource is separated into ”attributes” and “relationships”, where the “relationships” reference other, related objects.
- In addition to the “data” object, a response or request may contain an “included” section. This means a response will contain other objects that are referenced in the main resource section. This prevents the need for initiating multiple API calls to perform a single conceptual function.
Updated over 1 year ago