List Schemas - Flora API Documentation

list

curl --request GET \
  --url https://api.withflora.io/v1/schemas \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.withflora.io/v1/schemas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withflora.io/v1/schemas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withflora.io/v1/schemas"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.withflora.io/v1/schemas")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "data": [
      {
        "createdAt": "2025-03-20T15:37:16.163+00:00",
        "id": "00f9190e-9a4a-4e08-ba00-f888437ed3c4",
        "name": "News Articles",
        "structure": {
          "items": {
            "properties": {
              "link": {
                "describe": "URL to learn more",
                "type": "string"
              },
              "summary": {
                "describe": "The news summary",
                "type": "string"
              },
              "title": {
                "describe": "The article title",
                "type": "string"
              }
            },
            "type": "object"
          },
          "required": true,
          "type": "array"
        }
      }
    ],
    "meta": {
      "currentPage": 1,
      "firstPage": 1,
      "firstPageUrl": "/?page=1",
      "lastPage": 1,
      "lastPageUrl": "/?page=1",
      "nextPageUrl": null,
      "perPage": 10,
      "previousPageUrl": null,
      "total": 5
    }
  },
  "message": "Schemas fetched successfully",
  "status": true
}

GET

schemas

list

curl --request GET \
  --url https://api.withflora.io/v1/schemas \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.withflora.io/v1/schemas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withflora.io/v1/schemas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withflora.io/v1/schemas"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.withflora.io/v1/schemas")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "data": [
      {
        "createdAt": "2025-03-20T15:37:16.163+00:00",
        "id": "00f9190e-9a4a-4e08-ba00-f888437ed3c4",
        "name": "News Articles",
        "structure": {
          "items": {
            "properties": {
              "link": {
                "describe": "URL to learn more",
                "type": "string"
              },
              "summary": {
                "describe": "The news summary",
                "type": "string"
              },
              "title": {
                "describe": "The article title",
                "type": "string"
              }
            },
            "type": "object"
          },
          "required": true,
          "type": "array"
        }
      }
    ],
    "meta": {
      "currentPage": 1,
      "firstPage": 1,
      "firstPageUrl": "/?page=1",
      "lastPage": 1,
      "lastPageUrl": "/?page=1",
      "nextPageUrl": null,
      "perPage": 10,
      "previousPageUrl": null,
      "total": 5
    }
  },
  "message": "Schemas fetched successfully",
  "status": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startDate

string<date>

Example:

"2025-03-01"

endDate

string<date>

Example:

"2025-03-25"

string

Search schemas by name

Example:

"news"

page

integer

Example:

1

limit

integer

Example:

5

Response

200 - application/json

200

data

object

Show child attributes

message

string

Example:

"Schemas fetched successfully"

status

boolean

Example:

true