List Catalogs

Returns all catalogs registered in the specified project. Each catalog represents a data source connected to Peaka, such as Airtable, Stripe, or an internal Peaka storage. Built-in catalog types like internal (Peaka Tables and BI Tables) and query (Peaka Queries) are always present.

GET /data/projects/{projectId}/catalogs

List Catalogs

cURL

curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs', 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://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs",
  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://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs"

	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("https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs")

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

200

[
  {
    "id": "1",
    "name": "peaka",
    "displayName": "Peaka",
    "catalogType": "internal",
    "connectionId": null
  },
  {
    "id": "2",
    "name": "peaka",
    "displayName": "Peaka Query",
    "catalogType": "query",
    "connectionId": null
  },
  {
    "id": "555414570395501064",
    "name": "examplename34",
    "displayName": "exampleName34",
    "catalogType": "stripe",
    "connectionId": "fe47b030-3718-4537-a6ba-eaa93c7204ee"
  },
  {
    "id": "555611268656923356",
    "name": "examplename35",
    "displayName": "exampleName35",
    "catalogType": "segment",
    "connectionId": "fe47b030-3718-4537-a6ba-eaa93c7204ee"
  },
  {
    "id": "625151643029078208",
    "name": "exampleairtablecatalog2",
    "displayName": "exampleAirtableCatalog2",
    "catalogType": "airtable",
    "connectionId": "8db17e23-29de-4dab-8886-af9717e0e742"
  }
]

Authorizations

Authorization · string · header · required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

projectId · string · required

ID of the project

Response

200 - application/json

Successful operation

id · string

The ID of the catalog.

name · string

The name of the catalog.

displayName · string

The display name of the catalog.

catalogType · string

The type of the catalog.

connectionId · string

The connection ID of the catalog.