Flotiq

https://flotiq.com/docs
Admin
Flotiq is an API-first headless content management platform that automatically generates custom REST...
Tokens:264,342
Snippets:1,920
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Set up TodoMVC React example

Source: https://flotiq.com/docs/Deep-Dives/todomvc-react-headless-cms

Clone the TodoMVC repository, navigate to the React example, install dependencies with yarn, and start the development server. These commands are part of the initial setup for the tutorial.

```bash
git clone --depth=1 https://github.com/tastejs/todomvc.git

```

```bash
cd todomvc/examples/react

```

```bash
yarn

```

```bash
yarn run dev

```

--------------------------------

### Initialize Next.js project

Source: https://flotiq.com/docs/Universe/nextjs/nextjs-setup

Use this command to start the setup of a new Next.js project. Use '.' as the path to install in the current directory.

```bash
npx create-next-app@latest <path-to-nextjs-project>
```

--------------------------------

### Install dependencies and start Expo server

Source: https://flotiq.com/docs/Deep-Dives/mobile-expo-product-showcase

Navigate to the project directory, install dependencies, and start the Expo server. The server runs at http://localhost:19002.

```bash
cd flotiq-mobile-demo/
npm install
npm start

```

--------------------------------

### Install dependencies and start Gatsby development server

Source: https://flotiq.com/docs/Deep-Dives/jamstack-recipes-website-complex-data-structures

Navigate into the project directory, install dependencies, and start the Gatsby development server. The site will be available at http://localhost:8000.

```bash
cd gatsby-starter-recipes
npm install
gatsby develop

```

--------------------------------

### Install Gatsby globally

Source: https://flotiq.com/docs/Deep-Dives/jamstack-recipes-website-complex-data-structures

Install the Gatsby CLI globally using npm. This is the first step in the quickstart.

```bash
npm install -g gatsby

```

--------------------------------

### Example plugin-manifest.json configuration

Source: https://flotiq.com/docs/panel/PluginsDevelopment/plugins

A sample manifest file required for permanent organization-wide plugin installation.

```json
{
  "id": "my-organization.example-plugin",
  "name": "An Example plugin",
  "description": "This is plugin created by My Organization to handle an example workflow for all data types",
  "version": "1.0.0",
  "repository": "https://github.com/my-organization/flotiq-example-plugin",
  "url": "https://example.com/index.js",
  "permissions": [
    {
      "ctdName": "*",
      "canRead": true,
      "type": "CO"
    }
  ]
}
```

--------------------------------

### Run `npx flotiq-nextjs-setup` to install Flotiq SDK

Source: https://flotiq.com/docs/Deep-Dives/nextjs-react-typescript-openapi

This command installs the Flotiq SDK and also sets up a content cache revalidation endpoint and draft mode handling for a Next.js project. It is the recommended installation method.

```bash
npx flotiq-nextjs-setup

```

--------------------------------

### Install dependencies and build the package

Source: https://flotiq.com/docs/Deep-Dives/angular-headless-cms

Run these commands in the package directory to install dependencies and build the dist folder.

```bash
npm install
npm run build

```

--------------------------------

### Install the built package in your application

Source: https://flotiq.com/docs/Deep-Dives/angular-headless-cms

Run this command in your application directory to install the package from the dist folder.

```bash
npm install <path_to_your_package>/dist

```

--------------------------------

### Install node-fetch

Source: https://flotiq.com/docs/Deep-Dives/todomvc-react-headless-cms

Install node-fetch version 2 as a dependency to enable making HTTP requests from the React app.

```bash
npm install --save node-fetch@2

```

--------------------------------

### Install Expo CLI

Source: https://flotiq.com/docs/Flotiq-Mobile-Expo/overview

Install the Expo CLI globally. Required before cloning and running the Flotiq mobile demo project.

```bash
npm install --global expo-cli

```

--------------------------------

### 404Response example

Source: https://flotiq.com/docs/API/open-api-schema

Example response for a 404 error, using the 404Response schema.

```json
{
  "code": 404,
  "message": "Not found"
}
```

--------------------------------

### 401Response example

Source: https://flotiq.com/docs/API/open-api-schema

Example response for a 401 error, using the 401Response schema.

```json
{
  "code": 401,
  "message": "Unauthorized"
}
```

--------------------------------

### BatchResponseSuccess example

Source: https://flotiq.com/docs/API/open-api-schema

Example response for a successful batch operation. Shows the BatchResponseSuccess schema with zero errors.

```json
{
  "batch_total_count": 2,
  "batch_success_count": 2,
  "batch_error_count": 0,
  "errors": []
}
```

--------------------------------

### 403Response example

Source: https://flotiq.com/docs/API/open-api-schema

Example response for a 403 error, using the 403Response schema. Note that the schema definition includes a 'data' property but the example uses 'message'.

```json
{
  "code": 403,
  "message": "Access denied or quota limit exceeded"
}
```

--------------------------------

### OpenAPI Schema Example - _tagVersionsList

Source: https://flotiq.com/docs/API/open-api-schema

Definition for the _tagVersionsList schema, combining SystemListProperties with versionsList.

```json
{
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/SystemListProperties"
      },
      {
        "$ref": "#/components/schemas/versionsList"
      }
    ]
  }
```

--------------------------------

### OpenAPI Schema Example - _tag

Source: https://flotiq.com/docs/API/open-api-schema

Definition for the _tag schema, extending AbstractContentTypeSchemaDefinition with a required name property and an example including internal metadata.

```json
{
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
      },
      {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": ""
          }
        }
      }
    ],
    "required": [
      "name"
    ],
    "additionalProperties": false,
    "examples": [
      {
        "id": "_tag-1",
        "internal": {
          "contentType": "_tag",
          "createdAt": "2025-06-05T10:24:27+00:00",
          "updatedAt": "2025-06-05T10:24:27+00:00",
          "deletedAt": "",
          "workflowState": "saved",
          "objectTitle": "",
          "latestVersion": 1
        },
        "name": "name"
      }
    ]
  }
```

--------------------------------

### Batch update Media objects - request body example

Source: https://flotiq.com/docs/API/open-api-schema

Example request body for the Media_batchPut operation. It shows an array of Media objects with fields like id, extension, fileName, mimeType, size, type, source, tags, variants, externalId, url, height, and width. The example includes two identical objects.

```json
[
  {
    "id": "_media-698d20aa-193a-47b3-be4d-550c1aab47e7",
    "extension": "png",
    "fileName": "example_image.png",
    "mimeType": "image/png",
    "size": 87258,
    "type": "image",
    "source": "disk",
    "tags": [
      {
        "dataUrl": "/api/v1/content/_tag/_tag-641775",
        "type": "internal"
      }
    ],
    "variants": [
      {
        "name": "square",
        "trim": {
          "top": 10,
          "right": 10,
          "bottom": 10,
          "left": 10,
          "width": 10,
          "height": 10
        }
      }
    ],
    "externalId": "",
    "url": "/image/0x0/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png",
    "height": 517,
    "width": 925
  },
  {
    "id": "_media-698d20aa-193a-47b3-be4d-550c1aab47e7",
    "extension": "png",
    "fileName": "example_image.png",
    "mimeType": "image/png",
    "size": 87258,
    "type": "image",
    "source": "disk",
    "tags": [
      {
        "dataUrl": "/api/v1/content/_tag/_tag-641775",
        "type": "internal"
      }
    ],
    "variants": [
      {
        "name": "square",
        "trim": {
          "top": 10,
          "right": 10,
          "bottom": 10,
          "left": 10,
          "width": 10,
          "height": 10
        }
      }
    ],
    "externalId": "",
    "url": "/image/0x0/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png",
    "height": 517,
    "width": 925
  }
]
```

--------------------------------

### Media object example response

Source: https://flotiq.com/docs/API/open-api-schema

Example response body for a _media content object, showing fields like id, extension, fileName, mimeType, size, type, source, tags, variants, externalId, url, height, and width.

```json
{
  "id": "_media-698d20aa-193a-47b3-be4d-550c1aab47e7",
  "extension": "png",
  "fileName": "example_image.png",
  "mimeType": "image/png",
  "size": 87258,
  "type": "image",
  "source": "disk",
  "tags": [
    {
      "dataUrl": "/api/v1/content/_tag/_tag-641775",
      "type": "internal"
    }
  ],
  "variants": [
    {
      "name": "square",
      "trim": {
        "top": 10,
        "right": 10,
        "bottom": 10,
        "left": 10,
        "width": 10,
        "height": 10
      }
    }
  ],
  "externalId": "",
  "url": "/image/0x0/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png",
  "height": 517,
  "width": 925
}
```

--------------------------------

### BatchResponseError example

Source: https://flotiq.com/docs/API/open-api-schema

Example response for a batch operation with errors. Shows the structure of the BatchResponseError schema, including batch counts and per-item error details.

```json
{
  "batch_total_count": 2,
  "batch_success_count": 0,
  "batch_error_count": 2,
  "errors": [
    {
      "id": "test-1",
      "errors": {
        "name": [
          "The property name is required"
        ]
      }
    },
    {
      "id": "test-2",
      "errors": {
        "name": [
          "The property name is required"
        ]
      }
    }
  ]
}
```

--------------------------------

### OpenAPI Schema Example - _tagList

Source: https://flotiq.com/docs/API/open-api-schema

Definition for the _tagList schema, using SystemListProperties and a data array of _tag objects.

```json
{
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/SystemListProperties"
      },
      {
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/_tag"
            }
          }
        }
      }
    ]
  }
```

--------------------------------

### Batch delete request body example

Source: https://flotiq.com/docs/API/open-api-schema

Request body example for the batch delete endpoint, an array of content object IDs to delete.

```json
[
  "_media-1",
  "_media-2"
]
```

--------------------------------

### OpenAPI Schema Example - _mediaDefinition

Source: https://flotiq.com/docs/API/open-api-schema

Example of a schema definition for the _media content type, showing its properties including externalId, url, height, width, and internal metadata. Used for media file representation in the Flotiq API.

```json
{
          }
        ],
        "externalId": "",
        "url": "/image/0x0/_media-698d20aa-193a-47b3-be4d-550c1aab47e7.png",
        "height": 517,
        "width": 925,
        "internal": {
          "contentType": "_media",
          "createdAt": "2025-02-06T10:24:27+00:00",
          "updatedAt": "2025-02-06T10:24:27+00:00",
          "deletedAt": "",
          "workflowState": "saved",
          "objectTitle": "example_image.png",
          "latestVersion": 1
        }
      }
    ]
  },
  "_mediaList": {
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/SystemListProperties"
      },
      {
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/_media"
            }
          }
        }
      }
    ]
  },
  "_mediaVersionsList": {
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/SystemListProperties"
      },
      {
        "$ref": "#/components/schemas/versionsList"
      }
    ]
  }
```

--------------------------------

### OpenAPI Schema Example - _tagWithoutRequired

Source: https://flotiq.com/docs/API/open-api-schema

Definition for the _tagWithoutRequired schema, extending AbstractContentTypeSchemaDefinition without a required name field and including an example with internal metadata.

```json
{
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
      },
      {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": ""
          }
        }
      }
    ],
    "additionalProperties": false,
    "examples": [
      {
        "id": "_tag-1",
        "internal": {
          "contentType": "_tag",
          "createdAt": "2025-06-05T10:24:27+00:00",
          "updatedAt": "2025-06-05T10:24:27+00:00",
          "deletedAt": "",
          "workflowState": "saved",
          "objectTitle": "",
          "latestVersion": 1
        },
        "name": "name"
      }
    ]
  }
```

--------------------------------

### OpenAPI Schema Example - _tagWithoutInternal

Source: https://flotiq.com/docs/API/open-api-schema

Definition for the _tagWithoutInternal schema, extending AbstractContentTypeSchemaDefinitionWithoutInternal with a required name property and an example object.

```json
{
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/AbstractContentTypeSchemaDefinitionWithoutInternal"
      },
      {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": ""
          }
        }
      }
    ],
    "required": [
      "name"
    ],
    "additionalProperties": false,
    "examples": [
      {
        "id": "_tag-1",
        "name": "name"
      }
    ]
  }
```

--------------------------------

### OpenAPI Schema Example - versionItem

Source: https://flotiq.com/docs/API/open-api-schema

Definition for the versionItem schema, extending AbstractContentTypeSchemaDefinition with fields for id, deletedAt, createdAt, updatedAt, current, version, owner, and related user properties.

```json
{
    "type": "object",
    "allOf": [
      {
        "$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
      },
      {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "deletedAt": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          },
          "current": {
            "type": "boolean"
          },
          "version": {
            "type": "number"
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "firstName": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "roles": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
```

--------------------------------

### Response for full version 3.1

Source: https://flotiq.com/docs/API/open-api-schema

Example response for the version 3.1 Open API Schema request. The response is a JSON object with the openapi field set to 3.1.0.

```json
{
"openapi": "3.1.0",
"info": {

```

--------------------------------

### GET /api/v1/content/_media/{id}

Source: https://flotiq.com/docs/API/open-api-schema

Retrieves all information about a Media (internal) object by its identifier. Supports optional hydration of related objects.

```APIDOC
## GET /api/v1/content/_media/{id}

### Description
Returns all information about Media (internal) object.

### Method
GET

### Endpoint
/api/v1/content/_media/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ContentObject identifier

#### Query Parameters
- **hydrate** (number) - Optional - Should hydrate relations of object, for now only one level of hydration is possible. Minimum: 0, Maximum: 1, Default: 0

### Response
#### Success Response (200)
- Returns the _media object schema

#### Error Responses
- **401** - Unauthorized
- **404** - Not found
```

--------------------------------

### curl request to get Open API Schema

Source: https://flotiq.com/docs/API/open-api-schema

Use this curl command to fetch the default Open API Schema (version 3.0) from Flotiq. Replace YOUR_API_KEY with your Read-only or Read and write API key.

```bash
curl -X GET "https://api.flotiq.com/api/v1/open-api-schema.json" \
     -H 'accept: */*' \
     -H 'X-AUTH-TOKEN: YOUR_API_KEY' \
     -H 'Content-Type: application/json'

```

--------------------------------

### GET /api/v1/open-api-schema.json

Source: https://flotiq.com/docs/API/open-api-schema

Retrieves the Open API Schema for your Flotiq account. Supports specifying the schema version, filtering system endpoints, and expanding relations.

```APIDOC
## [GET] /api/v1/open-api-schema.json

### Description
Retrieves the Open API Schema for your Flotiq account. The schema can be limited to the user-defined content type definitions and can be generated in different versions (3.1, 3.0, or Swagger 2.0).

### Method
GET

### Endpoint
`https://api.flotiq.com/api/v1/open-api-schema.json`

### Parameters
#### Query Parameters
- **version** (string) - Optional - Version of the API schema. Possible values: `3.1`, `3` (default for OpenAPI 3.0), `2` (for Swagger 2.0).
- **user_only** (boolean) - Optional - If set to `true`, the schema is rendered without system endpoints. Default is `false`.
- **hydrate** (integer) - Optional - If relations to other Content Type Definitions should be expanded. Default `0` (no expansion), `1` expands the schema definition.

### Authentication
Required headers: `X-AUTH-TOKEN: YOUR_API_KEY` (read-only or read-and-write API key). Also `accept: */*` and `Content-Type: application/json`.

### Request Example
```
curl -X GET "https://api.flotiq.com/api/v1/open-api-schema.json" \
     -H 'accept: */*' \
     -H 'X-AUTH-TOKEN: YOUR_API_KEY' \
     -H 'Content-Type: application/json'
```

### Response
#### Success Response (200)
Returns the Open API Schema in the requested version (e.g., `3.1.0`). The response includes the `openapi` version and `info` object, along with full schema definitions.

#### Response Example
```
{
  "openapi": "3.1.0",
  "info": { ... }
}
```

```

--------------------------------

### Import example content into Flotiq

Source: https://flotiq.com/docs/Deep-Dives/netlify-zapier-gatsby-serverless-deployment-pipeline

Run this command to add 4 images and 2 recipes to your Flotiq account. Requires the example import script provided in the starter.

```bash
node ./example/importExample.js

```

--------------------------------

### Filter Example: startsWith

Source: https://flotiq.com/docs/API/content-type/listing-co?h=listin

Filters objects where the parameter starts with the filter value. Example: `filters={"id":{"type":"startsWith","filter":"1-"}}` returns objects with id starting with '1-'.

```json
filters={"id":{"type":"startsWith","filter":"1-"}}
```

```json
{
    "id": "1-id",
    "price": 50,
    "title": "product-1",
    "internal": {...}
}
```

```json
{
    "id": "2-id",
    "price": 100,
    "title": "product-2",
    "internal": {...}
},
{
    "id": "3-id",
    "price": 150,
    "title": "product-3",
    "internal": {...}
}
```

--------------------------------

### Run Flotiq Next.js setup

Source: https://flotiq.com/docs/Universe/nextjs/nextjs-setup

Execute this command to begin the Flotiq integration process, which includes SDK generation and environment variable configuration.

```bash
npx flotiq-nextjs-setup
```

--------------------------------

### PHP - cURL GET /api/auth-context

Source: https://flotiq.com/docs/API

PHP curl example that sends a GET request with X-AUTH-TOKEN header and prints the response or an error if curl fails.

```PHP + CURL
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.flotiq.com/api/auth-context",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
            "X-AUTH-TOKEN: YOUR_API_KEY",
        ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

```

--------------------------------

### GET response for possible transitions of an object

Source: https://flotiq.com/docs/API/workflow/content-publishing-workflow

Example response from a GET request to /api/v1/workflow/:content_type/:object_id, showing the current state and enabled transitions.

```json
{
    "state": "public",
    "enabled_transitions": [
        {
            "name": "_public_archive",
            "froms": [
                "public"
            ],
            "tos": [
                "archive"
            ]
        }
    ]
}
```

--------------------------------

### Complex GET request with parameters (C# RestSharp)

Source: https://flotiq.com/docs/API/content-type/listing-co?h=listin

Uses RestSharp to send a GET request with the same parameters as the cURL example, including URL-encoded filters. Requires an API key.

```csharp
var client = new RestClient("https://api.flotiq.com/api/v1/content/blogposts?page=1&limit=20&order_by=internal.createdAt&order_direction=asc&hydrate=0&filters=%7B%22title%22%3A%7B%22type%22%3A%22equals%22%2C%22filter%22%3A%22Hello%20world%22%7D%7D");
var request = new RestRequest(Method.GET);
request.AddHeader("X-AUTH-TOKEN", "YOUR_API_KEY");
IRestResponse response = client.Execute(request);

```

--------------------------------

### C# - RestSharp client GET /api/auth-context

Source: https://flotiq.com/docs/API

Use RestSharp to create a GET request and pass the X-AUTH-TOKEN header. This example uses the deprecated RestRequest constructor and AddHeader method.

```C#
var client = new RestClient("https://api.flotiq.com/api/auth-context");
var request = new RestRequest(Method.GET);
request.AddHeader("X-AUTH-TOKEN", "YOUR_API_KEY");
IRestResponse response = client.Execute(request);

```
Tokens:
Raw