Search the catalog
curl --request GET \
--url http://localhost:3000/api/v1/catalog \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/v1/catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/catalog",
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 := "http://localhost:3000/api/v1/catalog"
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))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/v1/catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/catalog")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"query": "<string>",
"total": 0,
"counts": {},
"projects": [
{
"slug": "<string>",
"name": "<string>",
"count": 0
}
],
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "brand",
"slug": "<string>",
"name": "<string>",
"address": "<string>",
"description": "<string>",
"status": "draft",
"release": 0,
"expires": "<string>",
"expiring": true,
"private": true,
"tags": [
"<string>"
],
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>"
},
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "brand",
"slug": "<string>",
"name": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"hidden": {
"count": 0,
"example": "<string>"
},
"next": 0
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}API Reference
Search the catalog
Every type at once, in every project of the organization you reach: assets, collections, brands, portals, and brands’ rules and pages. q takes free words and the filters inline (logo status:current type:asset); each filter is also a parameter. Counts per type and project; replaced, archived and expired matches are counted in hidden unless status asks for them.
Scope: read.
GET
/
api
/
v1
/
catalog
Search the catalog
curl --request GET \
--url http://localhost:3000/api/v1/catalog \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/api/v1/catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/api/v1/catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/catalog",
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 := "http://localhost:3000/api/v1/catalog"
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))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/v1/catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/catalog")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"query": "<string>",
"total": 0,
"counts": {},
"projects": [
{
"slug": "<string>",
"name": "<string>",
"count": 0
}
],
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "brand",
"slug": "<string>",
"name": "<string>",
"address": "<string>",
"description": "<string>",
"status": "draft",
"release": 0,
"expires": "<string>",
"expiring": true,
"private": true,
"tags": [
"<string>"
],
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>"
},
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "brand",
"slug": "<string>",
"name": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"hidden": {
"count": 0,
"example": "<string>"
},
"next": 0
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Authorizations
bearersession
An API key: ab_...
Query Parameters
Free words and inline filters
Repeat for several
Available options:
brand, collection, asset, portal, rule, page A project's slug
Repeat for several
Available options:
draft, in_review, current, replaced, archived Carrying this tag
Only what is downstream of this address or id
Only what is upstream of this address or id
me: what you hold Admin on directly
Page size
Required range:
1 <= x <= 100The previous page's next
Required range:
x >= 0Response
Results
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991