Comfortable | Docs
  • Comfortable Documentation
  • Concepts
    • Content Repositories
    • Content Types
    • Documents
    • Assets
    • Content Tree
    • Collections
    • Webhooks
    • Team
    • Locales
  • APIs
    • RESTful API
      • Endpoints
      • API Reference
        • Sorting
        • Filters
        • Localisation
        • Fields
        • Includes
        • Search
      • Query Examples
        • Collections
        • Single Documents
        • Single Assets
        • Sorting
        • Filters
        • Includes
    • Image Manipulation
  • SDKs
    • JavaScript
      • Query Options
      • Query All Documents
      • Query a Collection
      • Query a Single Document
      • Query an Alias
      • Query an Asset
      • Example: Filters
      • Example: Sorting
    • Nuxt.js
    • PHP
      • Query All Documents
      • Query Single Document
      • Query Collection
      • Query an Alias
      • Query an Asset
      • Fulltext Search
      • Query by Fields
      • Query by Type
      • Query by Id
      • Query by Tags
  • Guides
    • Vue Blog Example
  • Legal
    • Legal Notice
    • Privacy Policy
Powered by GitBook
On this page
  • Introduction
  • List of available Parameter Names
  • API CDN Cache
  • Field Types
  1. APIs
  2. RESTful API

API Reference

PreviousEndpointsNextSorting

Last updated 5 years ago

Introduction

The content delivery API provides common query parameters like limit, offset and sorting, but also offers advanced methods such as filters , locale for list endpoints like and .

Queries are submitted per GET method either by query parameters e.g. or as an URI Encoded JSON Object.

Queries longer than 11kB that can't be submitted using the GET method, and must be sent using the POST method. The payload is a JSON Object ()

POST requests up to 2kB are also supported by the API CDN Cache.

List of available Parameter Names

  • limit

  • offset

API CDN Cache

The first API call will hit our servers to provide the response. This response is cached and every additional call for the same route will be provided from the cache as long as the returned data for this call doesn't change.

Field Types

Name

API Output

Text

string

Richtext

{plain, html}

Number

number

Select

string|array

Assets

array

Date & Time

string

Relation

object|array

Location

object

Boolean

boolean

JSON

object

Color

string

Each request gets cached by a global CND Cache provided by . An API CDN Cache does not only boost the speed of responses for edge cases and in general, but also greatly increases the reliability and robustness of an API.

Fastly
sorting
filters
locale
fields
includes
search
includeTags
excludeTags
All Documents
Collections
embedAssets
Example