Skip to main content
GET
/
data
/
projects
/
{projectId}
/
catalogs
/
{catalogId}
Read Catalog
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs/{catalogId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "catalogType": "<string>",
  "connectionId": "<string>"
}

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

​
catalogId
string
required

ID of the catalog

Response

200 - application/json

Successful operation

This class represents a Catalog. It contains the id, name, display name, type, and connection ID of the catalog.

​
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.