Read Block Types
curl --request POST \
--url https://api.example.com/block_types/filter \
--header 'Content-Type: application/json' \
--data '
{
"block_types": {
"name": {
"like_": "marvin"
},
"slug": {
"any_": [
"<string>"
]
}
},
"block_schemas": {
"operator": "and_",
"block_type_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"block_capabilities": {
"all_": [
"write-storage",
"read-storage"
]
},
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"version": {
"any_": [
"2.0.0",
"2.1.0"
]
}
},
"offset": 0,
"limit": 123
}
'import requests
url = "https://api.example.com/block_types/filter"
payload = {
"block_types": {
"name": { "like_": "marvin" },
"slug": { "any_": ["<string>"] }
},
"block_schemas": {
"operator": "and_",
"block_type_id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"block_capabilities": { "all_": ["write-storage", "read-storage"] },
"id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"version": { "any_": ["2.0.0", "2.1.0"] }
},
"offset": 0,
"limit": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
block_types: {name: {like_: 'marvin'}, slug: {any_: ['<string>']}},
block_schemas: {
operator: 'and_',
block_type_id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
block_capabilities: {all_: ['write-storage', 'read-storage']},
id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
version: {any_: ['2.0.0', '2.1.0']}
},
offset: 0,
limit: 123
})
};
fetch('https://api.example.com/block_types/filter', 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.example.com/block_types/filter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'block_types' => [
'name' => [
'like_' => 'marvin'
],
'slug' => [
'any_' => [
'<string>'
]
]
],
'block_schemas' => [
'operator' => 'and_',
'block_type_id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'block_capabilities' => [
'all_' => [
'write-storage',
'read-storage'
]
],
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'version' => [
'any_' => [
'2.0.0',
'2.1.0'
]
]
],
'offset' => 0,
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/block_types/filter"
payload := strings.NewReader("{\n \"block_types\": {\n \"name\": {\n \"like_\": \"marvin\"\n },\n \"slug\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"block_schemas\": {\n \"operator\": \"and_\",\n \"block_type_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"block_capabilities\": {\n \"all_\": [\n \"write-storage\",\n \"read-storage\"\n ]\n },\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"version\": {\n \"any_\": [\n \"2.0.0\",\n \"2.1.0\"\n ]\n }\n },\n \"offset\": 0,\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/block_types/filter")
.header("Content-Type", "application/json")
.body("{\n \"block_types\": {\n \"name\": {\n \"like_\": \"marvin\"\n },\n \"slug\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"block_schemas\": {\n \"operator\": \"and_\",\n \"block_type_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"block_capabilities\": {\n \"all_\": [\n \"write-storage\",\n \"read-storage\"\n ]\n },\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"version\": {\n \"any_\": [\n \"2.0.0\",\n \"2.1.0\"\n ]\n }\n },\n \"offset\": 0,\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/block_types/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"block_types\": {\n \"name\": {\n \"like_\": \"marvin\"\n },\n \"slug\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"block_schemas\": {\n \"operator\": \"and_\",\n \"block_type_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"block_capabilities\": {\n \"all_\": [\n \"write-storage\",\n \"read-storage\"\n ]\n },\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"version\": {\n \"any_\": [\n \"2.0.0\",\n \"2.1.0\"\n ]\n }\n },\n \"offset\": 0,\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"documentation_url": "<string>",
"description": "<string>",
"code_example": "<string>",
"is_protected": false
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Block types
Read Block Types
Gets all block types. Optionally limit return with limit and offset.
POST
/
block_types
/
filter
Read Block Types
curl --request POST \
--url https://api.example.com/block_types/filter \
--header 'Content-Type: application/json' \
--data '
{
"block_types": {
"name": {
"like_": "marvin"
},
"slug": {
"any_": [
"<string>"
]
}
},
"block_schemas": {
"operator": "and_",
"block_type_id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"block_capabilities": {
"all_": [
"write-storage",
"read-storage"
]
},
"id": {
"any_": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"version": {
"any_": [
"2.0.0",
"2.1.0"
]
}
},
"offset": 0,
"limit": 123
}
'import requests
url = "https://api.example.com/block_types/filter"
payload = {
"block_types": {
"name": { "like_": "marvin" },
"slug": { "any_": ["<string>"] }
},
"block_schemas": {
"operator": "and_",
"block_type_id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"block_capabilities": { "all_": ["write-storage", "read-storage"] },
"id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"version": { "any_": ["2.0.0", "2.1.0"] }
},
"offset": 0,
"limit": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
block_types: {name: {like_: 'marvin'}, slug: {any_: ['<string>']}},
block_schemas: {
operator: 'and_',
block_type_id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
block_capabilities: {all_: ['write-storage', 'read-storage']},
id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
version: {any_: ['2.0.0', '2.1.0']}
},
offset: 0,
limit: 123
})
};
fetch('https://api.example.com/block_types/filter', 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.example.com/block_types/filter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'block_types' => [
'name' => [
'like_' => 'marvin'
],
'slug' => [
'any_' => [
'<string>'
]
]
],
'block_schemas' => [
'operator' => 'and_',
'block_type_id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'block_capabilities' => [
'all_' => [
'write-storage',
'read-storage'
]
],
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'version' => [
'any_' => [
'2.0.0',
'2.1.0'
]
]
],
'offset' => 0,
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/block_types/filter"
payload := strings.NewReader("{\n \"block_types\": {\n \"name\": {\n \"like_\": \"marvin\"\n },\n \"slug\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"block_schemas\": {\n \"operator\": \"and_\",\n \"block_type_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"block_capabilities\": {\n \"all_\": [\n \"write-storage\",\n \"read-storage\"\n ]\n },\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"version\": {\n \"any_\": [\n \"2.0.0\",\n \"2.1.0\"\n ]\n }\n },\n \"offset\": 0,\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/block_types/filter")
.header("Content-Type", "application/json")
.body("{\n \"block_types\": {\n \"name\": {\n \"like_\": \"marvin\"\n },\n \"slug\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"block_schemas\": {\n \"operator\": \"and_\",\n \"block_type_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"block_capabilities\": {\n \"all_\": [\n \"write-storage\",\n \"read-storage\"\n ]\n },\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"version\": {\n \"any_\": [\n \"2.0.0\",\n \"2.1.0\"\n ]\n }\n },\n \"offset\": 0,\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/block_types/filter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"block_types\": {\n \"name\": {\n \"like_\": \"marvin\"\n },\n \"slug\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"block_schemas\": {\n \"operator\": \"and_\",\n \"block_type_id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"block_capabilities\": {\n \"all_\": [\n \"write-storage\",\n \"read-storage\"\n ]\n },\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"version\": {\n \"any_\": [\n \"2.0.0\",\n \"2.1.0\"\n ]\n }\n },\n \"offset\": 0,\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"slug": "<string>",
"logo_url": "<string>",
"documentation_url": "<string>",
"description": "<string>",
"code_example": "<string>",
"is_protected": false
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Response
Successful Response
A block type's name
Pattern:
^[^/%&><]+$A block type's slug
Web URL for the block type's logo
Web URL for the block type's documentation
A short blurb about the corresponding block's intended use
A code snippet demonstrating use of the corresponding block
Protected block types cannot be modified via API.
Was this page helpful?
⌘I